FastComments.com

FastComments Ruby SDK

Dit is de officiële Ruby SDK voor FastComments.

Officiële Ruby SDK voor de FastComments API

Repository

Bekijk op GitHub


Installatie Internal Link

Voeg deze regel toe aan het Gemfile van uw applicatie:

gem 'fastcomments'

En voer vervolgens uit:

bundle install

Of installeer het zelf met:

gem install fastcomments

Bibliotheekinhoud

Deze bibliotheek bevat de gegenereerde API-client en de SSO-hulpprogramma's om het werken met de API makkelijker te maken.

Openbare vs beveiligde API's

Voor de API-client zijn er twee klassen, DefaultApi en PublicApi. De DefaultApi bevat methoden die uw API-sleutel vereisen, en PublicApi bevat API-aanroepen die rechtstreeks vanuit een browser/mobiel apparaat/etc. kunnen worden gedaan zonder authenticatie.

Snelstart Internal Link

Geauthenticeerde API's gebruiken (DefaultApi)

Belangrijk: Je moet je API-sleutel instellen op de ApiClient voordat je geauthenticeerde verzoeken doet. Als je dat niet doet, mislukken verzoeken met een 401-fout.

require 'fastcomments-client'

# Maak en configureer de API-client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# VEREIST: Stel je API-sleutel in (haal deze uit je FastComments-dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Maak de API-instantie met de geconfigureerde client
api = FastCommentsClient::DefaultApi.new(api_client)

# Nu kun je geauthenticeerde API-aanroepen doen
begin
  # Voorbeeld: Voeg een SSO-gebruiker toe
  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}"
  # Veelvoorkomende fouten:
  # - 401: API-sleutel ontbreekt of is ongeldig
  # - 400: Verzoekvalidatie mislukt
end

Gebruik van publieke API's (PublicApi)

Publieke eindpunten vereisen geen authenticatie:

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

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

Veelvoorkomende problemen

  1. 401 "missing-api-key" fout: Zorg ervoor dat je config.api_key['x-api-key'] = 'YOUR_KEY' instelt voordat je de DefaultApi-instantie aanmaakt.
  2. Verkeerde API-klasse: Gebruik DefaultApi voor server-side geauthenticeerde verzoeken, PublicApi voor client-side/publieke verzoeken.
  3. Null API-sleutel: De SDK zal authenticatie stilzwijgend overslaan als de API-sleutel null is, wat leidt tot 401-fouten.

Notities Internal Link

Broadcast-IDs

Je zult zien dat je in sommige API-aanroepen een broadcastId moet doorgeven. Wanneer je gebeurtenissen ontvangt, krijg je deze ID terug, zodat je het event kunt negeren als je van plan bent wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen, omdat het de beste ervaring biedt). Geef hier een UUID op. De ID moet uniek genoeg zijn om niet twee keer in een browsersessie voor te komen.

SSO (Single Sign-On)

Voor SSO-voorbeelden, zie hieronder.

SSO-gebruik Internal Link

Eenvoudige SSO

require 'fastcomments'
require 'fastcomments-client'

# Maak een 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}"

# Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

Veilige SSO

require 'fastcomments'
require 'fastcomments-client'

# Maak een 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}"

# Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

aggregate Internal Link

Aggregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, etc.) worden ondersteund.

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
parentTenantId string query Nee
includeStats boolean query Nee

Respons

Retourneert: AggregationResponse

Voorbeeld

aggregate Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
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 |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

get_audit_logs Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
limit number query Nee
skip number query Nee
order string query Nee
after number query Nee
before number query Nee

Antwoord

Retourneert: GetAuditLogs200Response

Voorbeeld

get_audit_logs Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit de commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

block_from_comment_public Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
commentId string path Ja
sso string query Nee

Antwoord

Retourneert: BlockFromCommentPublic200Response

Voorbeeld

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

un_block_comment_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
commentId string path Ja
sso string query Nee

Respons

Retourneert: UnBlockCommentPublic200Response

Voorbeeld

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

checked_comments_for_blocked Internal Link

Parameters

Name Type Locatie Verplicht Beschrijving
tenantId string query Ja
commentIds string query Ja Een door komma's gescheiden lijst met comment-id's.
sso string query Nee

Antwoord

Retourneert: CheckedCommentsForBlocked200Response

Voorbeeld

checked_comments_for_blocked Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | Een door komma's gescheiden lijst met comment-id's.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

block_user_from_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
userId string query Nee
anonUserId string query Nee

Respons

Retourneert: BlockFromCommentPublic200Response

Voorbeeld

block_user_from_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

create_comment_public Internal Link

Parameters

Name Type Location Required Description
tenantId string path Ja
urlId string query Ja
broadcastId string query Ja
sessionId string query Nee
sso string query Nee

Antwoord

Retourneert: CreateCommentPublic200Response

Voorbeeld

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

delete_comment Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
id string path Ja
contextUserId string query Nee
isLive boolean query Nee

Respons

Geeft terug: DeleteComment200Response

Voorbeeld

delete_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

delete_comment_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
editKey string query Nee
sso string query Nee

Reactie

Geeft terug: DeleteCommentPublic200Response

Voorbeeld

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

delete_comment_vote Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
voteId string path Ja
urlId string query Ja
broadcastId string query Ja
editKey string query Nee
sso string query Nee

Antwoord

Retourneert: DeleteCommentVote200Response

Voorbeeld

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

flag_comment Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
id string path Ja
userId string query Nee
anonUserId string query Nee

Response

Retourneert: FlagComment200Response

Voorbeeld

flag_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens weg van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

get_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: GetComment200Response

Voorbeeld

get_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

get_comment_text Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
editKey string query Nee
sso string query Nee

Antwoord

Retourneert: GetCommentText200Response

Voorbeeld

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

get_comment_vote_user_names Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
dir integer query Ja
sso string query Nee

Respons

Retourneert: GetCommentVoteUserNames200Response

Voorbeeld

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

get_comments Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
page integer query Nee
limit integer query Nee
skip integer query Nee
asTree boolean query Nee
skipChildren integer query Nee
limitChildren integer query Nee
maxTreeDepth integer query Nee
urlId string query Nee
userId string query Nee
anonUserId string query Nee
contextUserId string query Nee
hashTag string query Nee
parentId string query Nee
direction string query Nee

Respons

Retourneert: GetComments200Response

Voorbeeld

get_comments Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF # SortDirections |
29}
30
31begin
32
33 result = api_instance.get_comments(tenant_id, opts)
34 p result
35rescue FastCommentsClient::ApiError => e
36 puts "Error when calling DefaultApi->get_comments: #{e}"
37end
38

get_comments_public Internal Link

req tenantId urlId

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
urlId string query Ja
page integer query Nee
direction string query Nee
sso string query Nee
skip integer query Nee
skipChildren integer query Nee
limit integer query Nee
limitChildren integer query Nee
countChildren boolean query Nee
fetchPageForCommentId string query Nee
includeConfig boolean query Nee
countAll boolean query Nee
includei10n boolean query Nee
locale string query Nee
modules string query Nee
isCrawler boolean query Nee
includeNotificationCount boolean query Nee
asTree boolean query Nee
maxTreeDepth integer query Nee
useFullTranslationIds boolean query Nee
parentId string query Nee
searchText string query Nee
hashTags array query Nee
userId string query Nee
customConfigStr string query Nee
afterCommentId string query Nee
beforeCommentId string query Nee

Respons

Geeft terug: GetCommentsPublic200Response

Voorbeeld

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

lock_comment Internal Link

Parameters

Name Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nee

Response

Retourneert: LockComment200Response

Voorbeeld

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

pin_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nee

Antwoord

Geeft terug: PinComment200Response

Voorbeeld

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

save_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
isLive boolean query Nee
doSpamCheck boolean query Nee
sendEmails boolean query Nee
populateNotifications boolean query Nee

Respons

Retourneert: SaveComment200Response

Voorbeeld

save_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg voor de volgende regel om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

save_comments_bulk Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
isLive boolean query Nee
doSpamCheck boolean query Nee
sendEmails boolean query Nee
populateNotifications boolean query Nee

Respons

Retourneert: Array&lt;SaveComment200Response&gt;

Voorbeeld

save_comments_bulk Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # API-sleutelautorisatie configureren: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
28end
29

set_comment_text Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
editKey string query Nee
sso string query Nee

Response

Retourneert: SetCommentText200Response

Voorbeeld

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

un_block_user_from_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes
userId string query No
anonUserId string query No

Response

Retourneert: UnBlockCommentPublic200Response

Voorbeeld

un_block_user_from_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# stel autorisatie in
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

un_flag_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
userId string query Nee
anonUserId string query Nee

Respons

Retourneert: FlagComment200Response

Voorbeeld

un_flag_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.un_flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->un_flag_comment: #{e}"
26end
27

un_lock_comment Internal Link

Parameters

Naam Type Location Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nee

Respons

Geeft terug: LockComment200Response

Voorbeeld

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

un_pin_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
commentId string path Ja
broadcastId string query Ja
sso string query Nee

Antwoord

Retourneert: PinComment200Response

Voorbeeld

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

update_comment Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
id string path Ja
contextUserId string query Nee
doSpamCheck boolean query Nee
isLive boolean query Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_comment Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarmarkering van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

vote_comment Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja
commentId string pad Ja
urlId string query Ja
broadcastId string query Ja
sessionId string query Nee
sso string query Nee

Respons

Geeft terug: VoteComment200Response

Voorbeeld

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

add_domain_config Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja

Antwoord

Retourneert: AddDomainConfig200Response

Voorbeeld

add_domain_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
15
16begin
17
18 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_domain_config: #{e}"
22end
23

delete_domain_config Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
domain string path Ja

Antwoord

Retourneert: DeleteDomainConfig200Response

Voorbeeld

delete_domain_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

get_domain_config Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
domain string path Ja

Antwoord

Retourneert: GetDomainConfig200Response

Voorbeeld

get_domain_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # API-sleutelautorisatie configureren: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

get_domain_configs Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Respons

Geeft terug: GetDomainConfigs200Response

Voorbeeld

get_domain_configs Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

patch_domain_config Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
domainToUpdate string path Ja

Response

Retourneert: GetDomainConfig200Response

Voorbeeld

patch_domain_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken bij de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
16
17begin
18
19 result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_domain_config: #{e}"
23end
24

put_domain_config Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
domainToUpdate string path Ja

Antwoord

Retourneert: GetDomainConfig200Response

Voorbeeld

put_domain_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

create_email_template Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja

Respons

Retourneert: CreateEmailTemplate200Response

Voorbeeld

Voorbeeld create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Verwijder het commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

delete_email_template Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_email_template Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23

delete_email_template_render_error Internal Link

Parameters

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

Respons

Geeft terug: FlagCommentPublic200Response

Voorbeeld

delete_email_template_render_error Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer autorisatie met API-sleutel: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15error_id = 'error_id_example' # String |
16
17begin
18
19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
23end
24

get_email_template Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes

Respons

Retourneert: GetEmailTemplate200Response

Voorbeeld

get_email_template Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_email_template: #{e}"
22end
23

get_email_template_definitions Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Respons

Retourneert: GetEmailTemplateDefinitions200Response

Voorbeeld

get_email_template_definitions Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_email_template_definitions(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
21end
22

get_email_template_render_errors Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
skip number query Nee

Respons

Retourneert: GetEmailTemplateRenderErrors200Response

Voorbeeld

get_email_template_render_errors Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26

get_email_templates Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
skip number query Nee

Respons

Geeft terug: GetEmailTemplates200Response

Voorbeeld

get_email_templates Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Verwijder het commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25

render_email_template Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
locale string query Nee

Response

Retourneert: RenderEmailTemplate200Response

Voorbeeld

render_email_template Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody |
15opts = {
16 locale: 'locale_example' # String |
17}
18
19begin
20
21 result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->render_email_template: #{e}"
25end
26

update_email_template Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_email_template Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

get_event_log Internal Link

req tenantId urlId userIdWS

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
urlId string query Ja
userIdWS string query Ja
startTime integer query Ja
endTime integer query Ja

Antwoord

Geeft terug: GetEventLog200Response

Voorbeeld

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

get_global_event_log Internal Link

req tenantId urlId userIdWS

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
urlId string query Ja
userIdWS string query Ja
startTime integer query Ja
endTime integer query Ja

Response

Retourneert: GetEventLog200Response

Voorbeeld

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

create_feed_post Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
broadcastId string query Nee
isLive boolean query Nee
doSpamCheck boolean query Nee
skipDupCheck boolean query Nee

Respons

Retourneert: CreateFeedPost200Response

Voorbeeld

create_feed_post Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # API-sleutelautorisatie configureren: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

create_feed_post_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
broadcastId string query Nee
sso string query Nee

Respons

Retourneert: CreateFeedPostPublic200Response

Voorbeeld

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

delete_feed_post_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Yes
postId string path Yes
broadcastId string query No
sso string query No

Respons

Geeft terug: DeleteFeedPostPublic200Response

Voorbeeld

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

get_feed_posts Internal Link

req tenantId afterId

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
afterId string query Nee
limit integer query Nee
tags array query Nee

Respons

Retourneert: GetFeedPosts200Response

Voorbeeld

get_feed_posts Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 after_id: 'after_id_example', # String |
16 limit: 56, # Integer |
17 tags: ['inner_example'] # Array<String> |
18}
19
20begin
21
22 result = api_instance.get_feed_posts(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
26end
27

get_feed_posts_public Internal Link

req tenantId afterId

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
afterId string query Nee
limit integer query Nee
tags array query Nee
sso string query Nee
isCrawler boolean query Nee
includeUserInfo boolean query Nee

Response

Retourneert: GetFeedPostsPublic200Response

Voorbeeld

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

get_feed_posts_stats Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
postIds array query Ja
sso string query Nee

Antwoord

Retourneert: GetFeedPostsStats200Response

Voorbeeld

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

get_user_reacts_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
postIds array query Nee
sso string query Nee

Antwoord

Geeft terug: GetUserReactsPublic200Response

Voorbeeld

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

react_feed_post_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
postId string path Ja
isUndo boolean query Nee
broadcastId string query Nee
sso string query Nee

Respons

Retourneert: ReactFeedPostPublic200Response

Voorbeeld

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

update_feed_post Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_feed_post Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar voor de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
16
17begin
18
19 result = api_instance.update_feed_post(tenant_id, id, feed_post)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_feed_post: #{e}"
23end
24

update_feed_post_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
postId string path Ja
broadcastId string query Nee
sso string query Nee

Response

Geeft terug: CreateFeedPostPublic200Response

Voorbeeld

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

flag_comment_public Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
commentId string path Ja
isFlagged boolean query Ja
sso string query Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

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

add_hash_tag Internal Link

Parameters

Name Type Location Required Description
tenantId string query Nee

Antwoord

Geeft terug: AddHashTag200Response

Voorbeeld

add_hash_tag Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

add_hash_tags_bulk Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Nee

Antwoord

Geeft terug: AddHashTagsBulk200Response

Voorbeeld

add_hash_tags_bulk Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Decommenteer de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tags_bulk(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
24end
25

delete_hash_tag Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tag string path Yes
tenantId string query No

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_hash_tag Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer autorisatie met API-sleutel: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest |
17}
18
19begin
20
21 result = api_instance.delete_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
25end
26

get_hash_tags Internal Link

Parameters

Naam Type Location Vereist Beschrijving
tenantId string query Ja
page number query Nee

Response

Retourneert: GetHashTags200Response

Voorbeeld

get_hash_tags Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_hash_tags(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_hash_tags: #{e}"
24end
25

patch_hash_tag Internal Link

Parameters

Name Type Location Required Description
tag string path Ja
tenantId string query Nee

Antwoord

Retourneert: PatchHashTag200Response

Voorbeeld

patch_hash_tag Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

create_moderator Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Respons

Geeft terug: CreateModerator200Response

Voorbeeld

create_moderator Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody |
15
16begin
17
18 result = api_instance.create_moderator(tenant_id, create_moderator_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_moderator: #{e}"
22end
23

delete_moderator Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
id string path Ja
sendEmail string query Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_moderator Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 send_email: 'send_email_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_moderator(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_moderator: #{e}"
25end
26

get_moderator Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Retourneert: GetModerator200Response

Voorbeeld

get_moderator Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23

get_moderators Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
skip number query No

Antwoord

Retourneert: GetModerators200Response

Voorbeeld

get_moderators Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

send_invite Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes
fromName string query Yes

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

send_invite Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

update_moderator Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_moderator Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody |
16
17begin
18
19 result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_moderator: #{e}"
23end
24

delete_notification_count Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Reactie

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_notification_count Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23

get_cached_notification_count Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: GetCachedNotificationCount200Response

Voorbeeld

Voorbeeld van get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_cached_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
22end
23

get_notification_count Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
userId string query Nee
urlId string query Nee
fromCommentId string query Nee
viewed boolean query Nee
type string query Nee

Response

Retourneert: GetNotificationCount200Response

Voorbeeld

get_notification_count Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Verwijder het commentaar voor de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example' # String |
20}
21
22begin
23
24 result = api_instance.get_notification_count(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_notification_count: #{e}"
28end
29

get_notifications Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
userId string query Nee
urlId string query Nee
fromCommentId string query Nee
viewed boolean query Nee
type string query Nee
skip number query Nee

Respons

Retourneert: GetNotifications200Response

Voorbeeld

get_notifications Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken weg van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

update_notification Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
userId string query Nee

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_notification Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

add_page Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Antwoord

Retourneert: AddPageAPIResponse

Voorbeeld

add_page Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

delete_page Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes

Antwoord

Retourneert: DeletePageAPIResponse

Voorbeeld

delete_page Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer autorisatie met API-sleutel: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

get_page_by_urlid Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
urlId string query Ja

Respons

Retourneert: GetPageByURLIdAPIResponse

Voorbeeld

get_page_by_urlid Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_page_by_urlid(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
22end
23

get_pages Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Response

Retourneert: GetPagesAPIResponse

Voorbeeld

get_pages Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

patch_page Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Geeft terug: PatchPageAPIResponse

Voorbeeld

patch_page Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer autorisatie met API-sleutel: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
16
17begin
18
19 result = api_instance.patch_page(tenant_id, id, update_api_page_data)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_page: #{e}"
23end
24

delete_pending_webhook_event Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Yes
id string path Yes

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_pending_webhook_event Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Stel API-sleutelautorisatie in: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartegels van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

get_pending_webhook_event_count Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
commentId string query Nee
externalId string query Nee
eventType string query Nee
type string query Nee
domain string query Nee
attemptCountGT number query Nee

Respons

Geeft terug: GetPendingWebhookEventCount200Response

Voorbeeld

get_pending_webhook_event_count Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
29end
30

get_pending_webhook_events Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
commentId string query Nee
externalId string query Nee
eventType string query Nee
type string query Nee
domain string query Nee
attemptCountGT number query Nee
skip number query Nee

Respons

Retourneert: GetPendingWebhookEvents200Response

Voorbeeld

get_pending_webhook_events Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2, # Float |
21 skip: 1.2 # Float |
22}
23
24begin
25
26 result = api_instance.get_pending_webhook_events(tenant_id, opts)
27 p result
28rescue FastCommentsClient::ApiError => e
29 puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
30end
31

create_question_config Internal Link

Parameters

Naam Type Location Verplicht Beschrijving
tenantId string query Ja

Respons

Retourneert: CreateQuestionConfig200Response

Voorbeeld

create_question_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

delete_question_config Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Geeft terug: FlagCommentPublic200Response

Voorbeeld

delete_question_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configureer autorisatie
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_config: #{e}"
22end
23

get_question_config Internal Link

Parameters

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

Response

Retourneert: GetQuestionConfig200Response

Voorbeeld

get_question_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_config: #{e}"
22end
23

get_question_configs Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
skip number query Nee

Respons

Retourneert: GetQuestionConfigs200Response

Voorbeeld

get_question_configs Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

update_question_config Internal Link

Parameters

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

Response

Geeft terug: FlagCommentPublic200Response

Voorbeeld

update_question_config Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody |
16
17begin
18
19 result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_config: #{e}"
23end
24

create_question_result Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Antwoord

Geeft terug: CreateQuestionResult200Response

Voorbeeld

create_question_result Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

delete_question_result Internal Link

Parameters

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

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_question_result Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken weg voor de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

get_question_result Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: GetQuestionResult200Response

Voorbeeld

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

get_question_results Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
urlId string query Nee
userId string query Nee
startDate string query Nee
questionId string query Nee
questionIds string query Nee
skip number query Nee

Respons

Retourneert: GetQuestionResults200Response

Voorbeeld

get_question_results Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken weg voor de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 url_id: 'url_id_example', # String |
16 user_id: 'user_id_example', # String |
17 start_date: 'start_date_example', # String |
18 question_id: 'question_id_example', # String |
19 question_ids: 'question_ids_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_question_results: #{e}"
29end
30

update_question_result Internal Link

Parameters

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

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_question_result Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody |
16
17begin
18
19 result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_result: #{e}"
23end
24

aggregate_question_results Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
questionId string query Nee
questionIds array query Nee
urlId string query Nee
timeBucket string query Nee
startDate string query Nee
forceRecalculate boolean query Nee

Respons

Retourneert: AggregateQuestionResults200Response

Voorbeeld

aggregate_question_results Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # API-sleutelautorisatie configureren: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

bulk_aggregate_question_results Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
forceRecalculate boolean query Nee

Respons

Geeft terug: BulkAggregateQuestionResults200Response

Voorbeeld

bulk_aggregate_question_results Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Stel API key-autorisatie in: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

combine_comments_with_question_results Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
questionId string query Nee
questionIds array query Nee
urlId string query Nee
startDate string query Nee
forceRecalculate boolean query Nee
minValue number query Nee
maxValue number query Nee
limit number query Nee

Antwoord

Retourneert: CombineCommentsWithQuestionResults200Response

Voorbeeld

combine_comments_with_question_results Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# setup authorization
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
19 force_recalculate: true, # Boolean |
20 min_value: 1.2, # Float |
21 max_value: 1.2, # Float |
22 limit: 1.2 # Float |
23}
24
25begin
26
27 result = api_instance.combine_comments_with_question_results(tenant_id, opts)
28 p result
29rescue FastCommentsClient::ApiError => e
30 puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
31end
32

add_sso_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Antwoord

Retourneert: AddSSOUserAPIResponse

Voorbeeld

add_sso_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

delete_sso_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
deleteComments boolean query Nee
commentDeleteMode string query Nee

Respons

Retourneert: DeleteSSOUserAPIResponse

Voorbeeld

delete_sso_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

get_sso_user_by_email Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
email string path Ja

Antwoord

Retourneert: GetSSOUserByEmailAPIResponse

Voorbeeld

get_sso_user_by_email Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14email = 'email_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

get_sso_user_by_id Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Retourneert: GetSSOUserByIdAPIResponse

Voorbeeld

get_sso_user_by_id Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

get_sso_users Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
skip integer query Nee

Antwoord

Retourneert: GetSSOUsers200Response

Voorbeeld

get_sso_users Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 56 # Integer |
16}
17
18begin
19
20 result = api_instance.get_sso_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_sso_users: #{e}"
24end
25

patch_sso_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
updateComments boolean query Nee

Respons

Retourneert: PatchSSOUserAPIResponse

Voorbeeld

patch_sso_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens van de volgende regel om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->patch_sso_user: #{e}"
26end
27

put_sso_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
updateComments boolean query Nee

Antwoord

Retourneert: PutSSOUserAPIResponse

Voorbeeld

put_sso_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken weg van de volgende regel om een voorvoegsel in te stellen voor de API-sleutel, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->put_sso_user: #{e}"
26end
27

create_subscription Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja

Response

Retourneert: CreateSubscriptionAPIResponse

Voorbeeld

create_subscription Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

delete_subscription Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
id string path Ja
userId string query Nee

Antwoord

Retourneert: DeleteSubscriptionAPIResponse

Voorbeeld

delete_subscription Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

get_subscriptions Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
userId string query Nee

Response

Retourneert: GetSubscriptionsAPIResponse

Voorbeeld

get_subscriptions Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

get_tenant_daily_usages Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
yearNumber number query Nee
monthNumber number query Nee
dayNumber number query Nee
skip number query Nee

Respons

Retourneert: GetTenantDailyUsages200Response

Voorbeeld

get_tenant_daily_usages Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 year_number: 1.2, # Float |
16 month_number: 1.2, # Float |
17 day_number: 1.2, # Float |
18 skip: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tenant_daily_usages(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
27end
28

create_tenant_package Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Response

Retourneert: CreateTenantPackage200Response

Voorbeeld

Voorbeeld van create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody |
15
16begin
17
18 result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_package: #{e}"
22end
23

delete_tenant_package Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Geeft terug: FlagCommentPublic200Response

Voorbeeld

delete_tenant_package Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
22end
23

get_tenant_package Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes

Response

Retourneert: GetTenantPackage200Response

Voorbeeld

get_tenant_package Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarregel hieronder weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_package: #{e}"
22end
23

get_tenant_packages Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
skip number query Nee

Antwoord

Retourneert: GetTenantPackages200Response

Voorbeeld

get_tenant_packages Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_packages(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
24end
25

replace_tenant_package Internal Link

Parameters

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

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

replace_tenant_package Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody |
16
17begin
18
19 result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
23end
24

update_tenant_package Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Geeft terug: FlagCommentPublic200Response

Voorbeeld

update_tenant_package Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody |
16
17begin
18
19 result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant_package: #{e}"
23end
24

create_tenant_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Response

Geeft terug: CreateTenantUser200Response

Voorbeeld

create_tenant_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

delete_tenant_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
id string path Yes
deleteComments string query No
commentDeleteMode string query No

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_tenant_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: 'delete_comments_example', # String |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_tenant_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
26end
27

get_tenant_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: GetTenantUser200Response

Voorbeeld

get_tenant_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal commentaar van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

get_tenant_users Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
skip number query Nee

Antwoord

Geeft terug: GetTenantUsers200Response

Voorbeeld

get_tenant_users Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

replace_tenant_user Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
updateComments string query Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

replace_tenant_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key authorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken weg van de volgende regel om een prefix voor de API key in te stellen, bv. 'Bearer' (standaard is 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

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
redirectURL string query Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

send_login_link Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 redirect_url: 'redirect_url_example' # String |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

update_tenant_user Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
updateComments string query Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_tenant_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_tenant_user: #{e}"
26end
27

create_tenant Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja

Respons

Retourneert: CreateTenant200Response

Voorbeeld

create_tenant Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody |
15
16begin
17
18 result = api_instance.create_tenant(tenant_id, create_tenant_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant: #{e}"
22end
23

delete_tenant Internal Link

Parameters

Naam Type Location Vereist Beschrijving
tenantId string query Ja
id string path Ja
sure string query Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

delete_tenant Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 sure: 'sure_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_tenant(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_tenant: #{e}"
25end
26

get_tenant Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Response

Retourneert: GetTenant200Response

Voorbeeld

get_tenant Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant: #{e}"
22end
23

get_tenants Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
meta string query Nee
skip number query Nee

Respons

Retourneert: GetTenants200Response

Voorbeeld

get_tenants Example
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API key-autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 meta: 'meta_example', # String |
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_tenants(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_tenants: #{e}"
25end
26

update_tenant Internal Link

Parameteren

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

update_tenant Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

upload_image Internal Link

Een afbeelding uploaden en formaat wijzigen

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string path Ja
sizePreset string query Nee Grootte-voorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten)
urlId string query Nee Pagina-id waarvan de upload plaatsvindt, om te configureren

Antwoord

Retourneert: UploadImageResponse

Voorbeeld

upload_image Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Grootte-voorinstelling: \"Default\" (1000x1000px) of \"CrossPlatform\" (maakt formaten voor populaire apparaten)
10 url_id: 'url_id_example' # String | Pagina-id waarvan de upload plaatsvindt, om te configureren
11}
12
13begin
14
15 result = api_instance.upload_image(tenant_id, file, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->upload_image: #{e}"
19end
20

get_user_badge_progress_by_id Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
id string path Ja

Antwoord

Retourneert: GetUserBadgeProgressById200Response

Voorbeeld

get_user_badge_progress_by_id Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
22end
23

get_user_badge_progress_by_user_id Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
userId string path Ja

Response

Geeft terug: GetUserBadgeProgressById200Response

Voorbeeld

get_user_badge_progress_by_user_id Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Authenticatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel authenticatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Verwijder het commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

get_user_badge_progress_list Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Yes
userId string query No
limit number query No
skip number query No

Respons

Retourneert: GetUserBadgeProgressList200Response

Voorbeeld

get_user_badge_progress_list Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 limit: 1.2, # Float |
17 skip: 1.2 # Float |
18}
19
20begin
21
22 result = api_instance.get_user_badge_progress_list(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
26end
27

create_user_badge Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja

Response

Retourneert: CreateUserBadge200Response

Voorbeeld

create_user_badge Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# stel autorisatie in
5FastCommentsClient.configure do |config|
6 # Configureer API key autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
15
16begin
17
18 result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_user_badge: #{e}"
22end
23

delete_user_badge Internal Link

Parameters

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

Antwoord

Retourneert: UpdateUserBadge200Response

Voorbeeld

delete_user_badge Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23

get_user_badge Internal Link

Parameters

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

Response

Retourneert: GetUserBadge200Response

Voorbeeld

get_user_badge Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Verwijder de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

get_user_badges Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
userId string query Nee
badgeId string query Nee
type number query Nee
displayedOnComments boolean query Nee
limit number query Nee
skip number query Nee

Antwoord

Geeft terug: GetUserBadges200Response

Voorbeeld

get_user_badges Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 badge_id: 'badge_id_example', # String |
17 type: 1.2, # Float |
18 displayed_on_comments: true, # Boolean |
19 limit: 1.2, # Float |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

update_user_badge Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja

Respons

Retourneert: UpdateUserBadge200Response

Voorbeeld

update_user_badge Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar weg van de volgende regel om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
16
17begin
18
19 result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_user_badge: #{e}"
23end
24

get_user_notification_count Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
sso string query Nee

Antwoord

Retourneert: GetUserNotificationCount200Response

Voorbeeld

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

get_user_notifications Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
pageSize integer query Nee
afterId string query Nee
includeContext boolean query Nee
afterCreatedAt integer query Nee
unreadOnly boolean query Nee
dmOnly boolean query Nee
noDm boolean query Nee
includeTranslations boolean query Nee
sso string query Nee

Antwoord

Retourneert: GetUserNotifications200Response

Voorbeeld

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

reset_user_notification_count Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
sso string query Nee

Respons

Geeft terug: ResetUserNotifications200Response

Voorbeeld

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

reset_user_notifications Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
afterId string query Nee
afterCreatedAt integer query Nee
unreadOnly boolean query Nee
dmOnly boolean query Nee
noDm boolean query Nee
sso string query Nee

Response

Retourneert: ResetUserNotifications200Response

Voorbeeld

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

update_user_notification_comment_subscription_status Internal Link

Schakel meldingen in of uit voor een specifieke reactie.

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
notificationId string path Ja
optedInOrOut string path Ja
commentId string query Ja
sso string query Nee

Response

Geeft terug: UpdateUserNotificationStatus200Response

Voorbeeld

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

update_user_notification_page_subscription_status Internal Link

Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina abonneren, worden er meldingen aangemaakt voor nieuwe top-level reacties, en ook

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
urlId string query Ja
url string query Ja
pageTitle string query Ja
subscribedOrUnsubscribed string path Ja
sso string query Nee

Respons

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

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

update_user_notification_status Internal Link


Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
notificationId string path Ja
newStatus string path Ja
sso string query Nee

Respons

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

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

get_user_presence_statuses Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
urlIdWS string query Ja
userIds string query Ja

Antwoord

Retourneert: GetUserPresenceStatuses200Response

Voorbeeld

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

search_users Internal Link

Parameters

Name Type Location Required Description
tenantId string path Ja
urlId string query Ja
usernameStartsWith string query Ja
mentionGroupIds array query Nee
sso string query Nee

Respons

Geeft terug: SearchUsers200Response

Voorbeeld

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

get_user Internal Link

Parameters

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

Antwoord

Geeft terug: GetUser200Response

Voorbeeld

get_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23

create_vote Internal Link

Parameters

Naam Type Locatie Verplicht Beschrijving
tenantId string query Ja
commentId string query Ja
direction string query Ja
userId string query Nee
anonUserId string query Nee

Respons

Retourneert: VoteComment200Response

Voorbeeld

create_vote Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutel autorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarmarkering van de volgende regel om een prefix voor de API-sleutel in te stellen, bv. 'Bearer' (standaard nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14comment_id = 'comment_id_example' # String |
15direction = 'up' # String |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->create_vote: #{e}"
27end
28

delete_vote Internal Link

Parameters

Naam Type Locatie Vereist Beschrijving
tenantId string query Ja
id string path Ja
editKey string query Nee

Antwoord

Retourneert: DeleteCommentVote200Response

Voorbeeld

delete_vote Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer autorisatie met API-sleutel: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 edit_key: 'edit_key_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_vote(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_vote: #{e}"
25end
26

get_votes Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
urlId string query Ja

Antwoord

Retourneert: GetVotes200Response

Voorbeeld

get_votes Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# autorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaartekens weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_votes(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_votes: #{e}"
22end
23

get_votes_for_user Internal Link

Parameters

Name Type Location Required Description
tenantId string query Ja
urlId string query Ja
userId string query Nee
anonUserId string query Nee

Response

Retourneert: GetVotesForUser200Response

Voorbeeld

get_votes_for_user Voorbeeld
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# authorisatie instellen
5FastCommentsClient.configure do |config|
6 # Configureer API-sleutelautorisatie: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is 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

Hulp nodig?

Als u problemen ondervindt of vragen heeft over de Ruby SDK, neem dan:

Bijdragen

Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.