FastComments Ruby SDK

Dit is de officiële Ruby SDK voor FastComments.

Officiële Ruby SDK voor de FastComments API

Repository

Installatie

Voeg deze regel toe aan het Gemfile van je applicatie:

gem 'fastcomments'

Voer vervolgens uit:

bundle install

Of installeer het zelf met:

gem install fastcomments

Library Contents

Deze bibliotheek bevat de gegenereerde API‑client en de SSO‑hulpmiddelen om het werken met de API gemakkelijker te maken.

API Client Library Docs

Public vs Secured APIs

Voor de API‑client zijn er drie klassen: DefaultApi, PublicApi en ModerationApi. De DefaultApi bevat methoden die je API‑sleutel vereisen, en PublicApi bevat API‑aanroepen die rechtstreeks vanuit een browser/mobiel apparaat/etc. kunnen worden uitgevoerd zonder authenticatie. De ModerationApi bevat de methoden die het moderator‑dashboard mogelijk maken.

De ModerationApi biedt een uitgebreide reeks realtime en snelle moderatie‑API’s. Elke ModerationApi‑methode accepteert een sso‑parameter en kan authenticeren via SSO of een FastComments.com‑sessiecookie.

Snel aan de slag

Gebruik geauthentificeerde API's (DefaultApi)

Belangrijk: U moet uw API‑sleutel instellen op de ApiClient voordat u geauthentificeerde verzoeken doet. Als u dat niet doet, zullen verzoeken falen met een 401‑fout.

require 'fastcomments'

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

# VERPLICHT: Stel uw API‑sleutel in (haal deze op van uw 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 kunt u geauthentificeerde 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 openbare API's (PublicApi)

Openbare eindpunten vereisen geen authenticatie:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

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

Gebruik moderatie‑API's (ModerationApi)

De moderatiemethoden voeden het moderator‑dashboard. Geef een sso‑token door zodat het verzoek wordt gedaan namens een SSO‑geauthentificeerde moderator:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Voorbeeld: Lijst opmerkingen in de moderatiewachtrij
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Veelvoorkomende problemen

401 "missing-api-key" fout: Zorg ervoor dat u config.api_key['x-api-key'] = 'YOUR_KEY' instelt vóór het maken van de DefaultApi‑instantie.
Verkeerde API‑klasse: Gebruik DefaultApi voor server‑side geauthentificeerde verzoeken, PublicApi voor client‑side/openbare verzoeken, en ModerationApi voor verzoeken van het moderator‑dashboard.
Null API‑sleutel: De SDK zal stilzwijgend authenticatie overslaan als de API‑sleutel null is, wat leidt tot 401‑fouten.

Notities

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

Eenvoudige SSO

require 'fastcomments'

# Maak 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

Veilige SSO

require 'fastcomments'

# Maak 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

aggregate

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

Parameters

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

Antwoord

Geeft terug: AggregateResponse

Voorbeeld

aggregate Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

get_audit_logs

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Ja
limit	number	query	Nee
skip	number	query	Nee
order	string	query	Nee
after	number	query	Nee
before	number	query	Nee

Response

Retourneert: GetAuditLogsResponse

Voorbeeld

get_audit_logs Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# authorisatie instellen
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

logout_public

Respons

Geeft terug: APIEmptyResponse

Voorbeeld

logout_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
begin
  
  result = api_instance.logout_public
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->logout_public: #{e}"
end

block_from_comment_public

Parameters

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

Antwoord

Retourneert: BlockSuccess

Voorbeeld

Voorbeeld van block_from_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->block_from_comment_public: #{e}"
end

un_block_comment_public

Parameters

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

Response

Retourneert: UnblockSuccess

Voorbeeld

un_block_comment_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_block_comment_public: #{e}"
end

checked_comments_for_blocked

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja
commentIds	string	query	Ja	Een door komma's gescheiden lijst met comment-IDs.
sso	string	query	Nee

Respons

Retourneert: CheckBlockedCommentsResponse

Voorbeeld

Voorbeeld van checked_comments_for_blocked

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | Een door komma's gescheiden lijst met comment-IDs.
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
end

block_user_from_comment

Parameters

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

Respons

Retourneert: BlockSuccess

Voorbeeld

Voorbeeld van block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

create_comment_public

Parameters

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

Respons

Retourneert: SaveCommentsResponseWithPresence

Voorbeeld

create_comment_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_comment_public: #{e}"
end

delete_comment

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
id	string	path	Ja
contextUserId	string	query	Nee
isLive	boolean	query	Nee

Antwoord

Retourneert: DeleteCommentResult

Voorbeeld

delete_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Verwijder het commentaar voor de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

delete_comment_public

Parameters

Name	Type	Location	Required
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
editKey	string	query	Nee
sso	string	query	Nee

Antwoord

Retourneert: PublicAPIDeleteCommentResponse

Voorbeeld

delete_comment_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_public: #{e}"
end

delete_comment_vote

Parameters

Naam	Type	Locatie	Vereist
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

Respons

Retourneert: VoteDeleteResponse

Voorbeeld

delete_comment_vote Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_vote: #{e}"
end

flag_comment

Parameters

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

Antwoord

Geeft terug: FlagCommentResponse

Voorbeeld

flag_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

get_comment

Parameters

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

Respons

Retourneert: APIGetCommentResponse

Voorbeeld

get_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

get_comment_text

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	path	Yes
commentId	string	path	Yes
editKey	string	query	No
sso	string	query	No

Antwoord

Retourneert: PublicAPIGetCommentTextResponse

Voorbeeld

get_comment_text Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_text: #{e}"
end

get_comment_vote_user_names

Parameters

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

Response

Retourneert: GetCommentVoteUserNamesSuccessResponse

Voorbeeld

get_comment_vote_user_names Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
dir = 56 # Integer | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
end

get_comments

Parameters

Name	Type	Location	Required
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
fromDate	integer	query	Nee
toDate	integer	query	Nee

Respons

Geeft terug: APIGetCommentsResponse

Voorbeeld

get_comments Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # Integer | 
  to_date: 789 # Integer | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

get_comments_public

req tenantId urlId

Parameters

Naam	Type	Locatie	Vereist
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

Response

Retourneert: GetCommentsResponseWithPresencePublicComment

Voorbeeld

get_comments_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  page: 56, # Integer | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  sso: 'sso_example', # String | 
  skip: 56, # Integer | 
  skip_children: 56, # Integer | 
  limit: 56, # Integer | 
  limit_children: 56, # Integer | 
  count_children: true, # Boolean | 
  fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String | 
  include_config: true, # Boolean | 
  count_all: true, # Boolean | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  modules: 'modules_example', # String | 
  is_crawler: true, # Boolean | 
  include_notification_count: true, # Boolean | 
  as_tree: true, # Boolean | 
  max_tree_depth: 56, # Integer | 
  use_full_translation_ids: true, # Boolean | 
  parent_id: 'parent_id_example', # String | 
  search_text: 'search_text_example', # String | 
  hash_tags: ['inner_example'], # Array<String> | 
  user_id: 'user_id_example', # String | 
  custom_config_str: 'custom_config_str_example', # String | 
  after_comment_id: 'after_comment_id_example', # String | 
  before_comment_id: 'before_comment_id_example' # String | 
}
begin
  
  result = api_instance.get_comments_public(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_public: #{e}"
end

lock_comment

Parameters

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

Antwoord

Retourneert: APIEmptyResponse

Voorbeeld

lock_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->lock_comment: #{e}"
end

pin_comment

Parameters

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

Antwoord

Retourneert: ChangeCommentPinStatusResponse

Voorbeeld

pin_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

save_comment

Parameters

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

Respons

Retourneert: APISaveCommentResponse

Voorbeeld

Voorbeeld save_comment

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

save_comments_bulk

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Response

Geeft terug: SaveCommentsBulkResponse

Voorbeeld

save_comments_bulk Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

set_comment_text

Parameters

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

Respons

Geeft terug: PublicAPISetCommentTextResponse

Voorbeeld

set_comment_text Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->set_comment_text: #{e}"
end

un_block_user_from_comment

Parameters

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

Antwoord

Geeft terug: UnblockSuccess

Voorbeeld

un_block_user_from_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar bij de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

un_flag_comment

Parameters

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

Response

Retourneert: FlagCommentResponse

Voorbeeld

un_flag_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

un_lock_comment

Parameters

Name	Type	Location	Required
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
sso	string	query	Nee

Antwoord

Geeft terug: APIEmptyResponse

Voorbeeld

un_lock_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

un_pin_comment

Parameters

Name	Type	Location	Required
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
sso	string	query	Nee

Respons

Retourneert: ChangeCommentPinStatusResponse

Voorbeeld

un_pin_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_pin_comment: #{e}"
end

update_comment

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
id	string	path	Ja
contextUserId	string	query	Nee
doSpamCheck	boolean	query	Nee
isLive	boolean	query	Nee

Antwoord

Retourneert: APIEmptyResponse

Voorbeeld

update_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarteken weg van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

vote_comment

Parameters

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

Antwoord

Geeft terug: VoteResponse

Voorbeeld

vote_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

get_comments_for_user

Parameters

Naam	Type	Locatie	Vereist
userId	string	query	Nee
direction	string	query	Nee
repliesToUserId	string	query	Nee
page	number	query	Nee
includei10n	boolean	query	Nee
locale	string	query	Nee
isCrawler	boolean	query	Nee

Respons

Retourneert: GetCommentsForUserResponse

Voorbeeld

get_comments_for_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
opts = {
  user_id: 'user_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  replies_to_user_id: 'replies_to_user_id_example', # String | 
  page: 1.2, # Float | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  is_crawler: true # Boolean | 
}
begin
  
  result = api_instance.get_comments_for_user(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_for_user: #{e}"
end

add_domain_config

Parameters

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	query	Ja

Respons

Retourneert: AddDomainConfigResponse

Voorbeeld

add_domain_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

delete_domain_config

Parameters

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

Respons

Retourneert: DeleteDomainConfigResponse

Voorbeeld

delete_domain_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Stel API-sleutelautorisatie in: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het hekje van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

get_domain_config

Parameters

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

Response

Geeft terug: GetDomainConfigResponse

Voorbeeld

get_domain_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Stel API-sleutelautorisatie in: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

get_domain_configs

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Response

Geeft terug: GetDomainConfigsResponse

Voorbeeld

get_domain_configs Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

patch_domain_config

Parameters

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

Respons

Retourneert: PatchDomainConfigResponse

Voorbeeld

patch_domain_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

put_domain_config

Parameters

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

Antwoord

Retourneert: PutDomainConfigResponse

Voorbeeld

put_domain_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

create_email_template

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Respons

Retourneert: CreateEmailTemplateResponse

Voorbeeld

create_email_template Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

delete_email_template

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_email_template Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

delete_email_template_render_error

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_email_template_render_error Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

get_email_template

Parameters

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

Respons

Retourneert: GetEmailTemplateResponse

Voorbeeld

get_email_template Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

get_email_template_definitions

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Respons

Retourneert: GetEmailTemplateDefinitionsResponse

Voorbeeld

get_email_template_definitions Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep voor de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

get_email_template_render_errors

Parameters

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

Respons

Retourneert: GetEmailTemplateRenderErrorsResponse

Voorbeeld

get_email_template_render_errors Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

get_email_templates

Parameters

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

Response

Retourneert: GetEmailTemplatesResponse

Voorbeeld

get_email_templates Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar weg bij de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

render_email_template

Parameters

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

Respons

Retourneert: RenderEmailTemplateResponse

Voorbeeld

render_email_template Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

update_email_template

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

update_email_template Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

get_event_log

req tenantId urlId userIdWS

Parameters

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

Antwoord

Retourneert: GetEventLogResponse

Voorbeeld

get_event_log Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

get_global_event_log

req tenantId urlId userIdWS

Parameters

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

Respons

Retourneert: GetEventLogResponse

Voorbeeld

get_global_event_log Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

create_feed_post

Parameters

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

Respons

Retourneert: CreateFeedPostsResponse

Voorbeeld

create_feed_post Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

create_feed_post_public

Parameters

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

Antwoord

Retourneert: CreateFeedPostResponse

Voorbeeld

create_feed_post_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_feed_post_public: #{e}"
end

delete_feed_post_public

Parameters

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

Antwoord

Geeft terug: DeleteFeedPostPublicResponse

Voorbeeld

delete_feed_post_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
end

get_feed_posts

req tenantId afterId

Parameters

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

Antwoord

Retourneert: GetFeedPostsResponse

Voorbeeld

get_feed_posts Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

get_feed_posts_public

req tenantId afterId

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	path	Yes
afterId	string	query	No
limit	integer	query	No
tags	array	query	No
sso	string	query	No
isCrawler	boolean	query	No
includeUserInfo	boolean	query	No

Antwoord

Geeft terug: PublicFeedPostsResponse

Voorbeeld

get_feed_posts_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  is_crawler: true, # Boolean | 
  include_user_info: true # Boolean | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

get_feed_posts_stats

Parameters

Name	Type	Location	Required
tenantId	string	path	Ja
postIds	array	query	Ja
sso	string	query	Nee

Respons

Retourneert: FeedPostsStatsResponse

Voorbeeld

get_feed_posts_stats Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_ids = ['inner_example'] # Array<String> | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
end

get_user_reacts_public

Parameters

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

Respons

Geeft terug: UserReactsResponse

Voorbeeld

get_user_reacts_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  post_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_reacts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
end

react_feed_post_public

Parameters

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

Antwoord

Geeft terug: ReactFeedPostResponse

Voorbeeld

react_feed_post_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

update_feed_post

Parameters

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

Respons

Geeft terug: APIEmptyResponse

Voorbeeld

update_feed_post Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

update_feed_post_public

Parameters

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

Antwoord

Geeft terug: CreateFeedPostResponse

Voorbeeld

update_feed_post_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

flag_comment_public

Parameters

Name	Type	Location	Required
tenantId	string	query	Ja
commentId	string	path	Ja
isFlagged	boolean	query	Ja
sso	string	query	Nee

Respons

Geeft terug: APIEmptyResponse

Voorbeeld

flag_comment_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
is_flagged = true # Boolean | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->flag_comment_public: #{e}"
end

get_gif_large

Parameters

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

Respons

Retourneert: GifGetLargeResponse

Voorbeeld

get_gif_large Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # String | 
begin
  
  result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gif_large: #{e}"
end

get_gifs_search

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	path	Ja
search	string	query	Ja
locale	string	query	Nee
rating	string	query	Nee
page	number	query	Nee

Response

Retourneert: GetGifsSearchResponse

Voorbeeld

get_gifs_search Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
search = 'search_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_search(tenant_id, search, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_search: #{e}"
end

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	path	Ja
locale	string	query	Nee
rating	string	query	Nee
page	number	query	Nee

Antwoord

Retourneert: GetGifsTrendingResponse

Voorbeeld

get_gifs_trending Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

add_hash_tag

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Respons

Returns: CreateHashTagResponse

Voorbeeld

add_hash_tag Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Verwijder commentaar op de volgende regel om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

add_hash_tags_bulk

Parameters

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	query	Ja

Response

Retourneert: BulkCreateHashTagsResponse

Example

add_hash_tags_bulk Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Fout bij het aanroepen van DefaultApi->add_hash_tags_bulk: #{e}"
end

delete_hash_tag

Parameters

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

Reactie

Retourneert: APIEmptyResponse

Voorbeeld

delete_hash_tag Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Verwijder de commentaartekens van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

get_hash_tags

Parameters

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

Antwoord

Retourneert: GetHashTagsResponse

Voorbeeld

get_hash_tags Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

patch_hash_tag

Parameters

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

Respons

Returns: UpdateHashTagResponse

Voorbeeld

patch_hash_tag Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# stel autorisatie in
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens weg van de volgende regel om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

delete_moderation_vote

Parameters

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

Response

Returns: VoteDeleteResponse

Example

delete_moderation_vote Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Fout bij het aanroepen van ModerationApi->delete_moderation_vote: #{e}"
end

get_api_comments

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

Respons

Retourneert: ModerationAPIGetCommentsResponse

Voorbeeld

get_api_comments Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2, # Float | 
  count: 1.2, # Float | 
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Fout bij het aanroepen van ModerationApi->get_api_comments: #{e}"
end

get_api_export_status

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

Reactie

Retourneert: ModerationExportStatusResponse

Voorbeeld

get_api_export_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  batch_job_id: 'batch_job_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_export_status(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_export_status: #{e}"
end

get_api_ids

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
text-search	string	query	Nee
byIPFromComment	string	query	Nee
filters	string	query	Nee
searchFilters	string	query	Nee
afterId	string	query	Nee
demo	boolean	query	Nee
sso	string	query	Nee

Respons

Retourneert: ModerationAPIGetCommentIdsResponse

Voorbeeld

get_api_ids Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  after_id: 'after_id_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

get_ban_users_from_comment

Parameters

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

Respons

Retourneert: GetBannedUsersFromCommentResponse

Voorbeeld

get_ban_users_from_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
end

get_comment_ban_status

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Respons

Retourneert: GetCommentBanStatusResponse

Voorbeeld

get_comment_ban_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
end

get_comment_children

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Respons

Retourneert: ModerationAPIChildCommentsResponse

Voorbeeld

get_comment_children Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_children(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_children: #{e}"
end

get_count

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
text-search	string	query	Nee
byIPFromComment	string	query	Nee
filter	string	query	Nee
searchFilters	string	query	Nee
demo	boolean	query	Nee
sso	string	query	Nee

Respons

Retourneert: ModerationAPICountCommentsResponse

Voorbeeld

get_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filter: 'filter_example', # String | 
  search_filters: 'search_filters_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_count: #{e}"
end

get_counts

Parameters

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

Respons

Retourneert: GetBannedUsersCountResponse

Voorbeeld

get_counts Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_counts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_counts: #{e}"
end

get_logs

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Respons

Retourneert: ModerationAPIGetLogsResponse

Voorbeeld

get_logs Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_logs(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_logs: #{e}"
end

get_manual_badges

Parameters

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

Response

Retourneert: GetTenantManualBadgesResponse

Voorbeeld

get_manual_badges Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Fout bij het aanroepen van ModerationApi->get_manual_badges: #{e}"
end

get_manual_badges_for_user

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
badgesUserId	string	query	Nee
commentId	string	query	Nee
sso	string	query	Nee

Respons

Retourneert: GetUserManualBadgesResponse

Voorbeeld

Voorbeeld get_manual_badges_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  badges_user_id: 'badges_user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges_for_user(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges_for_user: #{e}"
end

get_moderation_comment

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Response

Returns: ModerationAPICommentResponse

Voorbeeld

get_moderation_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_email: true, # Boolean | 
  include_ip: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
end

get_moderation_comment_text

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nee

Respons

Retourneert: GetCommentTextResponse

Voorbeeld

get_moderation_comment_text Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
end

get_pre_ban_summary

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Ja
commentId	string	path	Ja
includeByUserIdAndEmail	boolean	query	Nee
includeByIP	boolean	query	Nee
includeByEmailDomain	boolean	query	Nee
sso	string	query	Nee

Respons

Retourneert: PreBanSummary

Voorbeeld

Voorbeeld get_pre_ban_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
end

get_search_comments_summary

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

Respons

Retourneert: ModerationCommentSearchResponse

Voorbeeld

Voorbeeld get_search_comments_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_comments_summary(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
end

get_search_pages

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
value	string	query	Nee
sso	string	query	Nee

Response

Retourneert: ModerationPageSearchResponse

Voorbeeld

Voorbeeld get_search_pages

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_pages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_pages: #{e}"
end

get_search_sites

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

Respons

Retourneert: ModerationSiteSearchResponse

Example

get_search_sites Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_sites(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_sites: #{e}"
end

get_search_suggest

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
text-search	string	query	Nee
sso	string	query	Nee

Response

Retourneert: ModerationSuggestResponse

Example

get_search_suggest Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_suggest(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_suggest: #{e}"
end

get_search_users

Parameters

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

Respons

Retourneert: ModerationUserSearchResponse

Voorbeeld

get_search_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_users: #{e}"
end

get_trust_factor

Parameters

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

Respons

Retourneert: GetUserTrustFactorResponse

Voorbeeld

get_trust_factor Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Fout bij het aanroepen van ModerationApi->get_trust_factor: #{e}"
end

get_user_ban_preference

Parameters

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

Respons

Retourneert: APIModerateGetUserBanPreferencesResponse

Voorbeeld

get_user_ban_preference Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_ban_preference(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
end

get_user_internal_profile

Parameters

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

Respons

Retourneert: GetUserInternalProfileResponse

Voorbeeld

get_user_internal_profile Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_internal_profile(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
end

post_adjust_comment_votes

Parameters

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

Respons

Retourneert: AdjustVotesResponse

Voorbeeld

post_adjust_comment_votes Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
end

post_api_export

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Respons

Returns: ModerationExportResponse

Voorbeeld

post_api_export Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_api_export: #{e}"
end

post_ban_user_from_comment

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Respons

Returns: BanUserFromCommentResult

Voorbeeld

post_ban_user_from_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  ban_email: true, # Boolean | 
  ban_email_domain: true, # Boolean | 
  ban_ip: true, # Boolean | 
  delete_all_users_comments: true, # Boolean | 
  banned_until: 'banned_until_example', # String | 
  is_shadow_ban: true, # Boolean | 
  update_id: 'update_id_example', # String | 
  ban_reason: 'ban_reason_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  # Fout bij het aanroepen van ModerationApi->post_ban_user_from_comment: #{e}
  puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
end

post_ban_user_undo

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

post_ban_user_undo Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
end

post_bulk_pre_ban_summary

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
includeByUserIdAndEmail	boolean	query	Nee
includeByIP	boolean	query	Nee
includeByEmailDomain	boolean	query	Nee
sso	string	query	Nee

Respons

Retourneert: BulkPreBanSummary

Voorbeeld

post_bulk_pre_ban_summary Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
end

post_comments_by_ids

Parameters

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

Respons

Retourneert: ModerationAPIChildCommentsResponse

Voorbeeld

post_comments_by_ids Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_comments_by_ids: #{e}"
end

post_flag_comment

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Respons

Retourneert: APIEmptyResponse

Voorbeeld

post_flag_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_flag_comment: #{e}"
end

post_remove_comment

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Response

Retourneert: PostRemoveCommentApiResponse

Example

post_remove_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_remove_comment: #{e}"
end

post_restore_deleted_comment

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

post_restore_deleted_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_restore_deleted_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
end

post_set_comment_approval_status

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Ja
commentId	string	path	Ja
approved	boolean	query	Nee
broadcastId	string	query	Nee
sso	string	query	Nee

Response

Retourneert: SetCommentApprovedResponse

Example

post_set_comment_approval_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  approved: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
end

post_set_comment_review_status

Parameters

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

Respons

Returns: APIEmptyResponse

Voorbeeld

post_set_comment_review_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  reviewed: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
end

post_set_comment_spam_status

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Response

Retourneert: APIEmptyResponse

Example

post_set_comment_spam_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  spam: true, # Boolean | 
  perm_not_spam: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
end

post_set_comment_text

Parameters

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

Respons

Retourneert: SetCommentTextResponse

Voorbeeld

post_set_comment_text Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_text: #{e}"
end

post_un_flag_comment

Parameters

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

Response

Retourneert: APIEmptyResponse

Example

post_un_flag_comment Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
end

post_vote

Parameters

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

Response

Retourneert: VoteResponse

Example

post_vote Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  direction: 'direction_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_vote(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_vote: #{e}"
end

put_award_badge

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
badgeId	string	query	Ja
userId	string	query	Nee
commentId	string	query	Nee
broadcastId	string	query	Nee
sso	string	query	Nee

Respons

Retourneert: AwardUserBadgeResponse

Voorbeeld

put_award_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_award_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_award_badge: #{e}"
end

put_close_thread

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
urlId	string	query	Ja
sso	string	query	Nee

Response

Retourneert: APIEmptyResponse

Example

put_close_thread Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_close_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_close_thread: #{e}"
end

put_remove_badge

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Response

Retourneert: RemoveUserBadgeResponse

Voorbeeld

put_remove_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_remove_badge: #{e}"
end

put_reopen_thread

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

Respons

Retourneert: APIEmptyResponse

Voorbeeld

put_reopen_thread Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
end

set_trust_factor

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
userId	string	query	Nee
trustFactor	string	query	Nee
sso	string	query	Nee

Respons

Retourneert: SetUserTrustFactorResponse

Voorbeeld

set_trust_factor Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  trust_factor: 'trust_factor_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->set_trust_factor: #{e}"
end

create_moderator

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Antwoord

Retourneert: CreateModeratorResponse

Voorbeeld

create_moderator Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

delete_moderator

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
id	string	path	Ja
sendEmail	string	query	Nee

Respons

Retourneert: APIEmptyResponse

Voorbeeld

delete_moderator Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

get_moderator

Parameters

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

Respons

Geeft terug: GetModeratorResponse

Voorbeeld

get_moderator Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

get_moderators

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja
skip	number	query	Nee

Respons

Retourneert: GetModeratorsResponse

Voorbeeld

get_moderators Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

send_invite

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

send_invite Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

update_moderator

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

update_moderator Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API key in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

delete_notification_count

Parameters

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

Respons

Geeft terug: APIEmptyResponse

Voorbeeld

delete_notification_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

get_cached_notification_count

Parameters

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

Respons

Retourneert: GetCachedNotificationCountResponse

Voorbeeld

get_cached_notification_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens voor de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

get_notification_count

Parameters

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

Antwoord

Retourneert: GetNotificationCountResponse

Voorbeeld

get_notification_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# stel autorisatie in
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

get_notifications

Parameters

Naam	Type	Locatie	Verplicht
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: GetNotificationsResponse

Voorbeeld

get_notifications Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

update_notification

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

update_notification Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# stel autorisatie in
FastCommentsClient.configure do |config|
  # Configureer API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

create_v1_page_react

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	path	Ja
urlId	string	query	Ja
title	string	query	Nee

Respons

Retourneert: CreateV1PageReact

Voorbeeld

create_v1_page_react Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v1_page_react: #{e}"
end

create_v2_page_react

Parameters

Name	Type	Location	Required
tenantId	string	path	Ja
urlId	string	query	Ja
id	string	query	Ja
title	string	query	Nee

Response

Retourneert: CreateV1PageReact

Voorbeeld

create_v2_page_react Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v2_page_react: #{e}"
end

delete_v1_page_react

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	pad	Ja
urlId	string	query	Ja

Response

Retourneert: CreateV1PageReact

Example

delete_v1_page_react Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.delete_v1_page_react(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
end

delete_v2_page_react

Parameters

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

Antwoord

Retourneert: CreateV1PageReact

Voorbeeld

Voorbeeld van delete_v2_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
end

get_v1_page_likes

Parameters

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

Antwoord

Geeft terug: GetV1PageLikes

Voorbeeld

get_v1_page_likes Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v1_page_likes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
end

get_v2_page_react_users

Parameters

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

Antwoord

Retourneert: GetV2PageReactUsersResponse

Voorbeeld

get_v2_page_react_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
end

get_v2_page_reacts

Parameters

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

Respons

Retourneert: GetV2PageReacts

Voorbeeld

get_v2_page_reacts Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v2_page_reacts(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
end

add_page

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Antwoord

Retourneert: AddPageAPIResponse

Voorbeeld

add_page Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

delete_page

Parameters

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

Antwoord

Retourneert: DeletePageAPIResponse

Voorbeeld

delete_page Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

get_offline_users

Vorige commentatoren op de pagina die NIET momenteel online zijn. Gesorteerd op displayName. Gebruik dit nadat /users/online is uitgeput om een "Leden" sectie weer te geven. Cursor-paginering op commenterName: server doorloopt de gedeeltelijke {tenantId, urlId, commenterName} index vanaf afterName voorwaarts via $gt, geen $skip-kosten.

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Pagina-URL-identificatie (server-side opgeschoond).
afterName	string	query	No	Cursor: geef nextAfterName mee uit de vorige reactie.
afterUserId	string	query	No	Cursor-tiebreaker: geef nextAfterUserId mee uit de vorige reactie. Vereist wanneer afterName is ingesteld zodat naamgelijkheden geen items laten vallen.

Response

Returns: PageUsersOfflineResponse

Example

get_offline_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Pagina-URL-identificatie (server-side opgeschoond).
opts = {
  after_name: 'after_name_example', # String | Cursor: geef nextAfterName mee uit de vorige reactie.
  after_user_id: 'after_user_id_example' # String | Cursor-tiebreaker: geef nextAfterUserId mee uit de vorige reactie. Vereist wanneer afterName is ingesteld zodat naamgelijkheden geen items laten vallen.
}
begin
  
  result = api_instance.get_offline_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_offline_users: #{e}"
end

get_online_users

Momenteel online kijkers van een pagina: mensen wiens websocket-sessie momenteel op de pagina geabonneerd is. Retourneert anonCount + totalCount (kamerbrede abonnees, inclusief anonieme kijkers die we niet opsommen).

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	path	Ja
urlId	string	query	Ja	Pagina-URL-identificator (geschoond aan serverzijde).
afterName	string	query	Nee	Cursor: geef nextAfterName door uit het vorige antwoord.
afterUserId	string	query	Nee	Cursor tiebreaker: geef nextAfterUserId door uit het vorige antwoord. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen items verloren gaan.

Respons

Retourneert: PageUsersOnlineResponse

Voorbeeld

get_online_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Pagina-URL-identificator (geschoond aan de serverzijde).
opts = {
  after_name: 'after_name_example', # String | Cursor: geef nextAfterName door uit het vorige antwoord.
  after_user_id: 'after_user_id_example' # String | Cursor tiebreaker: geef nextAfterUserId door uit het vorige antwoord. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen items verloren gaan.
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

get_page_by_urlid

Parameters

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

Respons

Retourneert: GetPageByURLIdAPIResponse

Voorbeeld

get_page_by_urlid Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

get_pages

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Response

Retourneert: GetPagesAPIResponse

Voorbeeld

get_pages Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

get_pages_public

Lijst pagina's voor een tenant. Gebruikt door de FChat desktop client om zijn kamerlijst te vullen. Vereist dat enableFChat op true staat in de opgeloste aangepaste configuratie voor elke pagina. Pagina's die SSO vereisen worden gefilterd op basis van de groepstoegang van de aanvragende gebruiker.

Parameters

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja
cursor	string	query	Nee	Opaque pagineringscursor die als `nextCursor` wordt geretourneerd van een eerdere aanvraag. Gebonden aan dezelfde `sortBy`.
limit	integer	query	Nee	1..200, standaard 50
q	string	query	Nee	Optionele niet-hoofdlettergevoelige titel-prefixfilter.
sortBy	string	query	Nee	Sorteervolgorde. `updatedAt` (standaard, nieuwste eerst), `commentCount` (meeste opmerkingen eerst), of `title` (alfabetisch).
hasComments	boolean	query	Nee	Als true, alleen pagina's retourneren met ten minste één opmerking.

Response

Retourneert: GetPublicPagesResponse

Voorbeeld

get_pages_public Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Opaque pagineringscursor die als `nextCursor` wordt geretourneerd van een eerdere aanvraag. Gebonden aan dezelfde `sortBy`.
  limit: 56, # Integer | 1..200, standaard 50
  q: 'q_example', # String | Optionele niet-hoofdlettergevoelige titel-prefixfilter.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Sorteervolgorde. `updatedAt` (standaard, nieuwste eerst), `commentCount` (meeste opmerkingen eerst), of `title` (alfabetisch).
  has_comments: true # Boolean | Als true, alleen pagina's retourneren met ten minste één opmerking.
}
begin
  
  result = api_instance.get_pages_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_pages_public: #{e}"
end

get_users_info

Bulk-gebruikersinformatie voor een tenant. Gegeven userIds, retourneert weergave-informatie van User / SSOUser. Wordt gebruikt door de commentaarwidget om gebruikers die zojuist zijn verschenen via een presence-event te verrijken. Geen paginacontext: privacy wordt uniform gehandhaafd (privéprofielen worden gemaskeerd).

Parameters

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja
ids	string	query	Ja	Door komma's gescheiden userIds.

Response

Retourneert: PageUsersInfoResponse

Voorbeeld

get_users_info Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | Door komma's gescheiden userIds.
begin
  
  result = api_instance.get_users_info(tenant_id, ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_users_info: #{e}"
end

patch_page

Parameters

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

Respons

Geeft terug: PatchPageAPIResponse

Voorbeeld

patch_page Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

delete_pending_webhook_event

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_pending_webhook_event Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Commentaar van de volgende regel verwijderen om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

get_pending_webhook_event_count

Parameters

Naam	Type	Locatie	Vereist
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

Retourneert: GetPendingWebhookEventCountResponse

Voorbeeld

get_pending_webhook_event_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # API-sleutelautorisatie configureren: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

get_pending_webhook_events

Parameters

Name	Type	Location	Required
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

Response

Retourneert: GetPendingWebhookEventsResponse

Voorbeeld

get_pending_webhook_events Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

create_question_config

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Response

Retourneert: CreateQuestionConfigResponse

Voorbeeld

create_question_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

delete_question_config

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_question_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

get_question_config

Parameters

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

Respons

Geeft terug: GetQuestionConfigResponse

Voorbeeld

get_question_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Verwijder het commentaarteken voor de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

get_question_configs

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja
skip	number	query	Nee

Antwoord

Geeft terug: GetQuestionConfigsResponse

Voorbeeld

get_question_configs Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

update_question_config

Parameters

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

Respons

Geeft terug: APIEmptyResponse

Voorbeeld

update_question_config Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

create_question_result

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Response

Retourneert: CreateQuestionResultResponse

Voorbeeld

create_question_result Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

delete_question_result

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

delete_question_result Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

get_question_result

Parameters

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

Respons

Retourneert: GetQuestionResultResponse

Voorbeeld

get_question_result Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

get_question_results

Parameters

Naam	Type	Locatie	Vereist
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: GetQuestionResultsResponse

Voorbeeld

get_question_results Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

update_question_result

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

update_question_result Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

aggregate_question_results

Parameters

Name	Type	Location	Required
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

Antwoord

Geeft terug: AggregateQuestionResultsResponse

Voorbeeld

Voorbeeld van aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Decommentarieer de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

bulk_aggregate_question_results

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja
forceRecalculate	boolean	query	Nee

Antwoord

Geeft terug: BulkAggregateQuestionResultsResponse

Voorbeeld

bulk_aggregate_question_results Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combine_comments_with_question_results

Parameters

Naam	Type	Locatie	Vereist
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

Respons

Retourneert: CombineQuestionResultsWithCommentsResponse

Voorbeeld

combine_comments_with_question_results Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

add_sso_user

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Antwoord

Retourneert: AddSSOUserAPIResponse

Voorbeeld

add_sso_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

delete_sso_user

Parameters

Naam	Type	Locatie	Vereist
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

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

get_sso_user_by_email

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

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

get_sso_user_by_id

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

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

get_sso_users

Parameters

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

Antwoord

Geeft terug: GetSSOUsersResponse

Voorbeeld

get_sso_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelauthorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

patch_sso_user

Parameters

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

Respons

Retourneert: PatchSSOUserAPIResponse

Voorbeeld

patch_sso_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

put_sso_user

Parameters

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

Antwoord

Retourneert: PutSSOUserAPIResponse

Voorbeeld

put_sso_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarteken weg van de volgende regel om een voorvoegsel in te stellen voor de API-sleutel, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

create_subscription

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Response

Retourneert: CreateSubscriptionAPIResponse

Voorbeeld

create_subscription Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

delete_subscription

Parameters

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

Antwoord

Retourneert: DeleteSubscriptionAPIResponse

Voorbeeld

delete_subscription Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

get_subscriptions

Parameters

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

Response

Retourneert: GetSubscriptionsAPIResponse

Voorbeeld

get_subscriptions Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

update_subscription

Parameters

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

Respons

Geeft terug: UpdateSubscriptionAPIResponse

Voorbeeld

update_subscription Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

get_tenant_daily_usages

Parameters

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

Respons

Geeft terug: GetTenantDailyUsagesResponse

Voorbeeld

get_tenant_daily_usages Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

create_tenant_package

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Antwoord

Retourneert: CreateTenantPackageResponse

Voorbeeld

create_tenant_package Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

delete_tenant_package

Parameters

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

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_tenant_package Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

get_tenant_package

Parameters

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

Response

Retourneert: GetTenantPackageResponse

Voorbeeld

get_tenant_package Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # config.api_key_prefix['x-api-key'] = 'Bearer'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

get_tenant_packages

Parameters

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

Respons

Geeft terug: GetTenantPackagesResponse

Voorbeeld

get_tenant_packages Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

replace_tenant_package

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

replace_tenant_package Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_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 | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

update_tenant_package

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

update_tenant_package Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

create_tenant_user

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Response

Geeft terug: CreateTenantUserResponse

Voorbeeld

create_tenant_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

delete_tenant_user

Parameters

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

Antwoord

Retourneert: APIEmptyResponse

Voorbeeld

delete_tenant_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Stel autorisatie met API-sleutel in: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

get_tenant_user

Parameters

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

Respons

Retourneert: GetTenantUserResponse

Voorbeeld

get_tenant_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

get_tenant_users

Parameters

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

Response

Retourneert: GetTenantUsersResponse

Voorbeeld

get_tenant_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie via API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaar voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

replace_tenant_user

Parameters

Name	Type	Location	Required
tenantId	string	query	Ja
id	string	path	Ja
updateComments	string	query	Nee

Response

Retourneert: APIEmptyResponse

Voorbeeld

replace_tenant_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar weg voor de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

Parameters

Naam	Type	Location	Vereist
tenantId	string	query	Ja
id	string	path	Ja
redirectURL	string	query	Nee

Antwoord

Retourneert: APIEmptyResponse

Voorbeeld

send_login_link Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

update_tenant_user

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	query	Ja
id	string	path	Ja
updateComments	string	query	Nee

Response

Retourneert: APIEmptyResponse

Voorbeeld

update_tenant_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

create_tenant

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Antwoord

Retourneert: CreateTenantResponse

Voorbeeld

create_tenant Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

delete_tenant

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
id	string	path	Ja
sure	string	query	Nee

Response

Retourneert: APIEmptyResponse

Voorbeeld

delete_tenant Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

get_tenant

Parameters

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

Antwoord

Retourneert: GetTenantResponse

Voorbeeld

get_tenant Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

get_tenants

Parameters

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

Antwoord

Retourneert: GetTenantsResponse

Voorbeeld

get_tenants Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie via API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

update_tenant

Parameters

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

Respons

Retourneert: APIEmptyResponse

Voorbeeld

update_tenant Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar voor de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

change_ticket_state

Parameters

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

Respons

Retourneert: ChangeTicketStateResponse

Voorbeeld

change_ticket_state Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API key in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

create_ticket

Parameters

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

Response

Retourneert: CreateTicketResponse

Voorbeeld

create_ticket Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer autorisatie met API-sleutel: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarstreep van de volgende regel weg om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

get_ticket

Parameters

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

Respons

Retourneert: GetTicketResponse

Voorbeeld

get_ticket Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een prefix voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

get_tickets

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
userId	string	query	Nee
state	number	query	Nee
skip	number	query	Nee
limit	number	query	Nee

Response

Retourneert: GetTicketsResponse

Example

get_tickets Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  state: 1.2, # Float | 
  skip: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tickets(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tickets: #{e}"
end

get_translations

Parameters

Naam	Type	Locatie	Vereist
namespace	string	path	Ja
component	string	path	Ja
locale	string	query	Nee
useFullTranslationIds	boolean	query	Nee

Respons

Retourneert: GetTranslationsResponse

Voorbeeld

get_translations Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # String | 
component = 'component_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  use_full_translation_ids: true # Boolean | 
}
begin
  
  result = api_instance.get_translations(namespace, component, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_translations: #{e}"
end

upload_image

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

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Grootte-voorinstelling: \"Default\" (1000x1000px) of \"CrossPlatform\" (maakt formaten voor populaire apparaten)
  url_id: 'url_id_example' # String | Pagina-id waarvan de upload plaatsvindt, om te configureren
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

get_user_badge_progress_by_id

Parameters

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

Respons

Retourneert: APIGetUserBadgeProgressResponse

Voorbeeld

get_user_badge_progress_by_id Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

get_user_badge_progress_by_user_id

Parameters

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

Antwoord

Retourneert: APIGetUserBadgeProgressResponse

Voorbeeld

get_user_badge_progress_by_user_id Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# Autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

get_user_badge_progress_list

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
userId	string	query	Nee
limit	number	query	Nee
skip	number	query	Nee

Antwoord

Retourneert: APIGetUserBadgeProgressListResponse

Voorbeeld

get_user_badge_progress_list Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # API-sleutelautorisatie configureren: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

create_user_badge

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja

Antwoord

Retourneert: APICreateUserBadgeResponse

Voorbeeld

create_user_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

delete_user_badge

Parameters

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

Respons

Geeft terug: APIEmptySuccessResponse

Voorbeeld

delete_user_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutel autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarteken weg van de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

get_user_badge

Parameters

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

Respons

Retourneert: APIGetUserBadgeResponse

Voorbeeld

get_user_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaartekens van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

get_user_badges

Parameters

Naam	Type	Locatie	Vereist
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

Respons

Retourneert: APIGetUserBadgesResponse

Voorbeeld

get_user_badges Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarmarkering van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

update_user_badge

Parameters

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

Response

Retourneert: APIEmptySuccessResponse

Voorbeeld

update_user_badge Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit het commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

get_user_notification_count

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Yes
sso	string	query	No

Antwoord

Geeft terug: GetUserNotificationCountResponse

Voorbeeld

get_user_notification_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

get_user_notifications

Parameters

Naam	Type	Locatie	Vereist	Beschrijving
tenantId	string	query	Ja
urlId	string	query	Nee	Wordt gebruikt om te bepalen of de huidige pagina is geabonneerd.
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
includeTenantNotifications	boolean	query	Nee
sso	string	query	Nee

Response

Geeft terug: GetMyNotificationsResponse

Voorbeeld

get_user_notifications Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | Wordt gebruikt om te bepalen of de huidige pagina is geabonneerd.
  page_size: 56, # Integer | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Boolean | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  include_translations: true, # Boolean | 
  include_tenant_notifications: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notifications: #{e}"
end

reset_user_notification_count

Parameters

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

Respons

Retourneert: ResetUserNotificationsResponse

Voorbeeld

reset_user_notification_count Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
end

reset_user_notifications

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

Respons

Retourneert: ResetUserNotificationsResponse

Voorbeeld

reset_user_notifications Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notifications: #{e}"
end

update_user_notification_comment_subscription_status

Schakelt meldingen voor een specifieke reactie in- of uitschakelen.

Parameters

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

Antwoord

Retourneert: UpdateUserNotificationCommentSubscriptionStatusResponse

Voorbeeld

Voorbeeld update_user_notification_comment_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
opted_in_or_out = 'in' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
end

update_user_notification_page_subscription_status

Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina abonneren, worden meldingen aangemaakt voor nieuwe rootreacties, en ook

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Yes
urlId	string	query	Yes
url	string	query	Yes
pageTitle	string	query	Yes
subscribedOrUnsubscribed	string	path	Yes
sso	string	query	No

Antwoord

Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse

Voorbeeld

Voorbeeld van update_user_notification_page_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
url = 'url_example' # String | 
page_title = 'page_title_example' # String | 
subscribed_or_unsubscribed = 'subscribe' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
end

update_user_notification_status

Parameters

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

Antwoord

Retourneert: UpdateUserNotificationStatusResponse

Voorbeeld

update_user_notification_status Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

get_user_presence_statuses

Parameters

Name	Type	Location	Required
tenantId	string	query	Ja
urlIdWS	string	query	Ja
userIds	string	query	Ja

Response

Retourneert: GetUserPresenceStatusesResponse

Example

get_user_presence_statuses Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id_ws = 'url_id_ws_example' # String | 
user_ids = 'user_ids_example' # String | 
begin
  
  result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
end

search_users

Parameters

Naam	Type	Locatie	Verplicht
tenantId	string	path	Ja
urlId	string	query	Ja
usernameStartsWith	string	query	Nee
mentionGroupIds	array	query	Nee
sso	string	query	Nee
searchSection	string	query	Nee

Respons

Geeft terug: SearchUsersResult

Voorbeeld

search_users Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  username_starts_with: 'username_starts_with_example', # String | 
  mention_group_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  search_section: 'fast' # String | 
}
begin
  
  result = api_instance.search_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->search_users: #{e}"
end

get_user

Parameters

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

Antwoord

Retourneert: GetUserResponse

Voorbeeld

get_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Stel API-sleutelautorisatie in: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar weg bij de volgende regel om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

create_vote

Parameters

Name	Type	Location	Required
tenantId	string	query	Ja
commentId	string	query	Ja
direction	string	query	Ja
userId	string	query	Nee
anonUserId	string	query	Nee

Antwoord

Geeft terug: VoteResponse

Voorbeeld

create_vote Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de volgende regel uit commentaar om een voorvoegsel voor de API-sleutel in te stellen, bijvoorbeeld 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

delete_vote

Parameters

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

Antwoord

Retourneert: VoteDeleteResponse

Voorbeeld

delete_vote Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal het commentaarteken van de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  edit_key: 'edit_key_example' # String | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

get_votes

Parameters

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

Response

Geeft terug: GetVotesResponse

Voorbeeld

get_votes Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API-sleutelautorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaar op de volgende regel weg om een voorvoegsel voor de API-sleutel in te stellen, bijv. 'Bearer' (standaard nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

get_votes_for_user

Parameters

Naam	Type	Locatie	Vereist
tenantId	string	query	Ja
urlId	string	query	Ja
userId	string	query	Nee
anonUserId	string	query	Nee

Respons

Geeft terug: GetVotesForUserResponse

Voorbeeld

get_votes_for_user Voorbeeld

Copy

require 'time'
require 'fastcomments-client'
# autorisatie instellen
FastCommentsClient.configure do |config|
  # Configureer API key-autorisatie: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Haal de commentaarteken weg voor de volgende regel om een voorvoegsel voor de API key in te stellen, bijv. 'Bearer' (standaard is nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

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.

Taal 🇳🇱 Nederlands

Aan de slag

Documentatie

Gebruik

Aggregatie

Auditlogs

Authenticatie

Blokkeren vanaf opmerking

Geblokkeerde reacties controleren

Reacties

Reacties voor gebruiker

Domeinconfiguraties

E-mailsjablonen

Gebeurtenislogboek

Feed-berichten

Reactie vlaggen

GIFs

Hashtags

Moderatie

Moderatoren

Meldingentelling

Meldingen

Pagina-reacties

Pagina's

Wachtende webhook-evenementen

Vraagconfiguraties

Vraagresultaten

Aggregatie van vraagresultaten

SSO-gebruikers

Abonnementen

Dagelijks gebruik van tenant

Tenant-pakketten

Tenantgebruikers

Tenants

Tickets

Vertalingen

Afbeelding uploaden

Voortgang gebruikersbadge

Gebruikersbadges

Gebruikersmeldingen

Gebruikersaanwezigheidsstatus

Gebruikerszoeken

Gebruikers

Stemmen

FastComments Ruby SDK

Repository

Installatie

Library Contents

Public vs Secured APIs

Snel aan de slag

Gebruik geauthentificeerde API's (DefaultApi)

Gebruik openbare API's (PublicApi)

Gebruik moderatie‑API's (ModerationApi)

Veelvoorkomende problemen

Notities

Broadcast-IDs

SSO (Single Sign-On)

SSO-gebruik

Eenvoudige SSO

Veilige SSO

aggregate

Parameters

Antwoord

Voorbeeld

get_audit_logs

Parameters

Response

Voorbeeld

logout_public

Respons

Voorbeeld

block_from_comment_public

Parameters

Antwoord

Voorbeeld

un_block_comment_public

Parameters

Response

Voorbeeld

checked_comments_for_blocked