FastComments Ruby SDK

Dette er den officielle Ruby SDK for FastComments.

Officiel Ruby SDK til FastComments API'en

Repository

Installation

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Biblioteksindhold

Dette bibliotek indeholder den genererede API‑klient og SSO‑værktøjerne, der gør arbejdet med API’en lettere.

API Client Library Docs

Offentlige vs sikrede API’er

For API‑klienten findes der tre klasser, DefaultApi, PublicApi og ModerationApi. DefaultApi indeholder metoder, der kræver din API‑nøgle, og PublicApi indeholder API‑kald, der kan foretages direkte fra en browser/mobil enhed osv. uden autentifikation. ModerationApi indeholder metoderne, der driver moderator‑dashboardet.

ModerationApi leverer en omfattende suite af live‑ og hurtige moderations‑API’er. Hver ModerationApi‑metode accepterer en sso‑parameter og kan autentificere via SSO eller en FastComments.com‑session‑cookie.

Hurtig start

Brugen af godkendte API'er (DefaultApi)

Vigtigt: Du skal sætte din API-nøgle på ApiClient, før du laver godkendte anmodninger. Hvis du ikke gør det, vil anmodninger mislykkes med en 401-fejl.

require 'fastcomments'

# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)

# Now you can make authenticated API calls
begin
  # Example: Add an SSO user
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

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

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # Common errors:
  # - 401: API key is missing or invalid
  # - 400: Request validation failed
end

Brugen af offentlige API'er (PublicApi)

Offentlige slutpunkter kræver ikke godkendelse:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

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

Brugen af moderations-API'er (ModerationApi)

Moderationsmetoderne driver moderator‑dashboardet. Overgiv en sso‑token, så anmodningen foretages på vegne af en SSO-godkendt moderator:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Example: List comments in the moderation queue
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Almindelige problemer

401 "missing-api-key" fejl: Sørg for, at du sætter config.api_key['x-api-key'] = 'YOUR_KEY' før du opretter DefaultApi‑instansen.
Forkert API‑klasse: Brug DefaultApi til server‑side godkendte anmodninger, PublicApi til klient‑side/offentlige anmodninger, og ModerationApi til anmodninger fra moderator‑dashboardet.
Null API‑nøgle: SDK'en vil stille og roligt springe godkendelse over, hvis API‑nøglen er null, hvilket medfører 401‑fejl.

Noter

Broadcast-id'er

Du vil se, at du skal sende et broadcastId i nogle API-opkald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du skal ignorere hændelsen, hvis du har tænkt dig at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.

SSO (Single Sign-On)

For SSO-eksempler, se nedenfor.

Brug af SSO

Simpel SSO

require 'fastcomments'

# Create Simple SSO token
user = FastComments::SSO::SimpleSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  avatar: 'https://example.com/avatar.jpg'
)

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

puts "SSO Token: #{token}"

# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

Sikker SSO

require 'fastcomments'

# Create Secure SSO token
user = FastComments::SSO::SecureSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  username: 'johndoe',
  avatar: 'https://example.com/avatar.jpg'
)

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

puts "Secure SSO Token: #{token}"

# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

aggregate

Aggregerer dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
parentTenantId	string	query	Nej
includeStats	boolean	query	Nej

Svar

Returnerer: AggregateResponse

Eksempel

aggregate Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Placering	Krævet
tenantId	string	query	Ja
limit	number	query	Nej
skip	number	query	Nej
order	string	query	Nej
after	number	query	Nej
before	number	query	Nej

Svar

Returnerer: GetAuditLogsResponse

Eksempel

get_audit_logs Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Svar

Returnerer: APIEmptyResponse

Eksempel

logout_public Eksempel

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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Svar

Returnerer: BlockSuccess

Eksempel

block_from_comment_public Eksempel

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

Parametre

Name	Type	Location	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Svar

Returnerer: UnblockSuccess

Eksempel

un_block_comment_public Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
commentIds	string	query	Ja	En kommasepareret liste over kommentar-id'er.
sso	string	query	Nej

Svar

Returnerer: CheckBlockedCommentsResponse

Eksempel

checked_comments_for_blocked Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | En kommasepareret liste over kommentar-id'er.
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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
userId	string	query	Nej
anonUserId	string	query	Nej

Svar

Returnerer: BlockSuccess

Eksempel

block_user_from_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: SaveCommentsResponseWithPresence

Eksempel

create_comment_public Eksempel

Copy

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

Parametre

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

Svar

Returnerer: DeleteCommentResult

Eksempel

delete_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
editKey	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: PublicAPIDeleteCommentResponse

Eksempel

delete_comment_public Eksempel

Copy

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

Parametre

Name	Type	Location	Required
tenantId	string	path	Yes
commentId	string	path	Yes
voteId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

Svar

Returnerer: VoteDeleteResponse

Eksempel

delete_comment_vote Eksempel

Copy

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

Parametre

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

Svar

Returnerer: FlagCommentResponse

Eksempel

flag_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIGetCommentResponse

Eksempel

get_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
editKey	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: PublicAPIGetCommentTextResponse

Eksempel

get_comment_text Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
dir	integer	query	Ja
sso	string	query	Nej

Svar

Returnerer: GetCommentVoteUserNamesSuccessResponse

Eksempel

Eksempel på get_comment_vote_user_names

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
page	integer	query	Nej
limit	integer	query	Nej
skip	integer	query	Nej
asTree	boolean	query	Nej
skipChildren	integer	query	Nej
limitChildren	integer	query	Nej
maxTreeDepth	integer	query	Nej
urlId	string	query	Nej
userId	string	query	Nej
anonUserId	string	query	Nej
contextUserId	string	query	Nej
hashTag	string	query	Nej
parentId	string	query	Nej
direction	string	query	Nej
fromDate	integer	query	Nej
toDate	integer	query	Nej

Svar

Returnerer: APIGetCommentsResponse

Eksempel

get_comments Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet for følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	sti	Ja
urlId	string	forespørgsel	Ja
page	integer	forespørgsel	Nej
direction	string	forespørgsel	Nej
sso	string	forespørgsel	Nej
skip	integer	forespørgsel	Nej
skipChildren	integer	forespørgsel	Nej
limit	integer	forespørgsel	Nej
limitChildren	integer	forespørgsel	Nej
countChildren	boolean	forespørgsel	Nej
fetchPageForCommentId	string	forespørgsel	Nej
includeConfig	boolean	forespørgsel	Nej
countAll	boolean	forespørgsel	Nej
includei10n	boolean	forespørgsel	Nej
locale	string	forespørgsel	Nej
modules	string	forespørgsel	Nej
isCrawler	boolean	forespørgsel	Nej
includeNotificationCount	boolean	forespørgsel	Nej
asTree	boolean	forespørgsel	Nej
maxTreeDepth	integer	forespørgsel	Nej
useFullTranslationIds	boolean	forespørgsel	Nej
parentId	string	forespørgsel	Nej
searchText	string	forespørgsel	Nej
hashTags	array	forespørgsel	Nej
userId	string	forespørgsel	Nej
customConfigStr	string	forespørgsel	Nej
afterCommentId	string	forespørgsel	Nej
beforeCommentId	string	forespørgsel	Nej

Svar

Returnerer: GetCommentsResponseWithPresencePublicComment

Eksempel

get_comments_public Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på lock_comment

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: ChangeCommentPinStatusResponse

Eksempel

pin_comment Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Svar

Returnerer: APISaveCommentResponse

Eksempel

save_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (defaults to 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
isLive	boolean	query	Nej
doSpamCheck	boolean	query	Nej
sendEmails	boolean	query	Nej
populateNotifications	boolean	query	Nej

Respons

Returnerer: SaveCommentsBulkResponse

Eksempel

save_comments_bulk Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet foran følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: PublicAPISetCommentTextResponse

Eksempel

set_comment_text Eksempel

Copy

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

Parametre

Navn	Type	Placering	Krævet
tenantId	string	query	Ja
id	string	path	Ja
userId	string	query	Nej
anonUserId	string	query	Nej

Svar

Returnerer: UnblockSuccess

Eksempel

un_block_user_from_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Respons

Returnerer: FlagCommentResponse

Eksempel

un_flag_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-autorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
commentId	string	path	Ja
broadcastId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

un_lock_comment Eksempel

Copy

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

Parametre

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

Svar

Returnerer: ChangeCommentPinStatusResponse

Eksempel

un_pin_comment Eksempel

Copy

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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

update_comment Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Krævet
tenantId	string	path	Yes
commentId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

Svar

Returnerer: VoteResponse

Eksempel

vote_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
userId	string	query	Nej
direction	string	query	Nej
repliesToUserId	string	query	Nej
page	number	query	Nej
includei10n	boolean	query	Nej
locale	string	query	Nej
isCrawler	boolean	query	Nej

Svar

Returnerer: GetCommentsForUserResponse

Eksempel

get_comments_for_user Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: AddDomainConfigResponse

Eksempel

add_domain_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra den følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: DeleteDomainConfigResponse

Eksempel

Eksempel på delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Streng | 
domain = 'domain_example' # Streng | 
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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
domain	string	path	Ja

Svar

Returnerer: GetDomainConfigResponse

Eksempel

get_domain_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: GetDomainConfigsResponse

Eksempel

get_domain_configs Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
domainToUpdate	string	path	Ja

Svar

Returnerer: PatchDomainConfigResponse

Eksempel

Eksempel på patch_domain_config

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
domainToUpdate	string	path	Ja

Svar

Returnerer: PutDomainConfigResponse

Eksempel

put_domain_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: CreateEmailTemplateResponse

Eksempel

create_email_template Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API key-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_email_template Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
errorId	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_email_template_render_error Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: GetEmailTemplateResponse

Eksempel

get_email_template Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Svar

Returnerer: GetEmailTemplateDefinitionsResponse

Eksempel

get_email_template_definitions Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
skip	number	query	Nej

Svar

Returnerer: GetEmailTemplateRenderErrorsResponse

Eksempel

Eksempel på get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# Opsætning af godkendelse
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
skip	number	query	Nej

Svar

Returnerer: GetEmailTemplatesResponse

Eksempel

get_email_templates Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
locale	string	query	Nej

Respons

Returnerer: RenderEmailTemplateResponse

Eksempel

render_email_template Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

update_email_template Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
urlId	string	query	Ja
userIdWS	string	query	Ja
startTime	integer	query	Ja
endTime	integer	query	Nej

Svar

Returnerer: GetEventLogResponse

Eksempel

get_event_log Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
urlId	string	query	Ja
userIdWS	string	query	Ja
startTime	integer	query	Ja
endTime	integer	query	Nej

Svar

Returnerer: GetEventLogResponse

Eksempel

get_global_event_log Eksempel

Copy

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

Parametre

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

Svar

Returnerer: CreateFeedPostsResponse

Eksempel

create_feed_post Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar for følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: CreateFeedPostResponse

Eksempel

create_feed_post_public Eksempel

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

Parametre

Name	Type	Location	Required
tenantId	string	path	Ja
postId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: DeleteFeedPostPublicResponse

Eksempel

delete_feed_post_public Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
afterId	string	query	Nej
limit	integer	query	Nej
tags	array	query	Nej

Respons

Returnerer: GetFeedPostsResponse

Eksempel

get_feed_posts Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
afterId	string	query	Nej
limit	integer	query	Nej
tags	array	query	Nej
sso	string	query	Nej
isCrawler	boolean	query	Nej
includeUserInfo	boolean	query	Nej

Svar

Returnerer: PublicFeedPostsResponse

Eksempel

get_feed_posts_public Eksempel

Copy

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

Parametre

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

Svar

Returnerer: FeedPostsStatsResponse

Eksempel

get_feed_posts_stats Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
postIds	array	query	Nej
sso	string	query	Nej

Svar

Returnerer: UserReactsResponse

Eksempel

get_user_reacts_public Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
postId	string	path	Ja
isUndo	boolean	query	Nej
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ReactFeedPostResponse

Eksempel

react_feed_post_public Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

update_feed_post Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
postId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: CreateFeedPostResponse

Eksempel

Eksempel på update_feed_post_public

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
isFlagged	boolean	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

flag_comment_public Eksempel

Copy

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

Parametre

Name	Type	Location	Required	Description
tenantId	string	sti	Ja
largeInternalURLSanitized	string	forespørgsel	Ja

Svar

Returnerer: GifGetLargeResponse

Eksempel

get_gif_large Eksempel

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

Parametre

Name	Type	Location	Required
tenantId	string	path	Ja
search	string	query	Ja
locale	string	query	Nej
rating	string	query	Nej
page	number	query	Nej

Svar

Returnerer: GetGifsSearchResponse

Eksempel

get_gifs_search Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	path	Ja
locale	string	query	Nej
rating	string	query	Nej
page	number	query	Nej

Svar

Returnerer: GetGifsTrendingResponse

Eksempel

get_gifs_trending Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: CreateHashTagResponse

Eksempel

add_hash_tag Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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 "Fejl ved kald af DefaultApi->add_hash_tag: #{e}"
end

add_hash_tags_bulk

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: BulkCreateHashTagsResponse

Eksempel

add_hash_tags_bulk Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar fra følgende linje for at indstille et præfiks for API-nøglen, f.eks. 'Bearer' (defaults to 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 "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

delete_hash_tag

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Yes
tag	string	path	Yes

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_hash_tag Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle autorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (defaults to 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
page	number	query	Nej

Svar

Returnerer: GetHashTagsResponse

Eksempel

get_hash_tags Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Location	Påkrævet	Beskrivelse
tenantId	string	query	Ja
tag	string	path	Ja

Svar

Returnerer: UpdateHashTagResponse

Eksempel

patch_hash_tag Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle autorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
voteId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: VoteDeleteResponse

Eksempel

delete_moderation_vote Eksempel

Copy

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

get_api_comments

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

Svar

Returnerer: ModerationAPIGetCommentsResponse

Eksempel

get_api_comments Eksempel

Copy

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 "Error when calling ModerationApi->get_api_comments: #{e}"
end

get_api_export_status

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
batchJobId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationExportStatusResponse

Eksempel

get_api_export_status Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

Respons

Returnerer: ModerationAPIGetCommentIdsResponse

Eksempel

get_api_ids Eksempel

Copy

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 "Fejl ved kald af ModerationApi->get_api_ids: #{e}"
end

get_ban_users_from_comment

Parameters

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Svar

Returnerer: GetBannedUsersFromCommentResponse

Eksempel

get_ban_users_from_comment Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Svar

Returnerer: GetCommentBanStatusResponse

Eksempel

get_comment_ban_status Eksempel

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

Parametre

Navn	Type	Placering	Obligatorisk
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Respons

Returnerer: ModerationAPIChildCommentsResponse

Eksempel

get_comment_children Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
text-search	string	query	Nej
byIPFromComment	string	query	Nej
filter	string	query	Nej
searchFilters	string	query	Nej
demo	boolean	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationAPICountCommentsResponse

Eksempel

get_count Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Respons

Returnerer: GetBannedUsersCountResponse

Eksempel

get_counts Eksempel

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

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Response

Returnerer: ModerationAPIGetLogsResponse

Eksempel

get_logs Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: GetTenantManualBadgesResponse

Eksempel

get_manual_badges Eksempel

Copy

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 "Error when calling ModerationApi->get_manual_badges: #{e}"
end

get_manual_badges_for_user

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
badgesUserId	string	query	Nej
commentId	string	query	Nej
sso	string	query	Nej

Respons

Returnerer: GetUserManualBadgesResponse

Eksempel

get_manual_badges_for_user Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
includeEmail	boolean	query	Nej
includeIP	boolean	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationAPICommentResponse

Eksempel

get_moderation_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
sso	string	query	Nej

Svar

Returnerer: GetCommentTextResponse

Eksempel

get_moderation_comment_text Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Svar

Returnerer: PreBanSummary

Eksempel

get_pre_ban_summary Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Streng | 
comment_id = 'comment_id_example' # Streng | 
opts = {
  include_by_user_id_and_email: true, # Boolesk | 
  include_by_ip: true, # Boolesk | 
  include_by_email_domain: true, # Boolesk | 
  sso: 'sso_example' # Streng | 
}
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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
value	string	query	Nej
filters	string	query	Nej
searchFilters	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationCommentSearchResponse

Eksempel

get_search_comments_summary Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
value	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationPageSearchResponse

Eksempel

get_search_pages Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
value	string	query	Nej
sso	string	query	Nej

Respons

Returnerer: ModerationSiteSearchResponse

Eksempel

get_search_sites Eksempel

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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
text-search	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationSuggestResponse

Eksempel

get_search_suggest Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
value	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: ModerationUserSearchResponse

Eksempel

get_search_users Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
userId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: GetUserTrustFactorResponse

Eksempel

get_trust_factor Eksempel

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 "Error when calling ModerationApi->get_trust_factor: #{e}"
end

get_user_ban_preference

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Respons

Returnerer: APIModerateGetUserBanPreferencesResponse

Eksempel

get_user_ban_preference Eksempel

Copy

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 "Fejl ved kald af ModerationApi->get_user_ban_preference: #{e}"
end

get_user_internal_profile

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: GetUserInternalProfileResponse

Eksempel

get_user_internal_profile Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: AdjustVotesResponse

Eksempel

post_adjust_comment_votes Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
text-search	string	query	Nej
byIPFromComment	string	query	Nej
filters	string	query	Nej
searchFilters	string	query	Nej
sorts	string	query	Nej
sso	string	query	Nej

Respons

Returnerer: ModerationExportResponse

Eksempel

post_api_export Eksempel

Copy

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 "Fejl ved kald af ModerationApi->post_api_export: #{e}"
end

post_ban_user_from_comment

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
banEmail	boolean	query	Nej
banEmailDomain	boolean	query	Nej
banIP	boolean	query	Nej
deleteAllUsersComments	boolean	query	Nej
bannedUntil	string	query	Nej
isShadowBan	boolean	query	Nej
updateId	string	query	Nej
banReason	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: BanUserFromCommentResult

Eksempel

post_ban_user_from_comment Eksempel

Copy

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
  puts "Fejl ved kald af ModerationApi->post_ban_user_from_comment: #{e}"
end

post_ban_user_undo

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_ban_user_undo Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Svar

Returnerer: BulkPreBanSummary

Eksempel

post_bulk_pre_ban_summary Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: ModerationAPIChildCommentsResponse

Eksempel

post_comments_by_ids Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_flag_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Svar

Returns: PostRemoveCommentApiResponse

Eksempel

post_remove_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_restore_deleted_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Svar

Returnerer: SetCommentApprovedResponse

Eksempel

post_set_comment_approval_status Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
reviewed	boolean	query	Nej
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_set_comment_review_status Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
spam	boolean	query	Nej
permNotSpam	boolean	query	Nej
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_set_comment_spam_status Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Svar

Returnerer: SetCommentTextResponse

Eksempel

post_set_comment_text Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

post_un_flag_comment Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	path	Ja
direction	string	query	Nej
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: VoteResponse

Eksempel

post_vote Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Svar

Returnerer: AwardUserBadgeResponse

Eksempel

put_award_badge Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
urlId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

put_close_thread Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
badgeId	string	query	Ja
userId	string	query	Nej
commentId	string	query	Nej
broadcastId	string	query	Nej
sso	string	query	Nej

Svar

Returnerer: RemoveUserBadgeResponse

Eksempel

put_remove_badge Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
urlId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

put_reopen_thread Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

Svar

Returnerer: SetUserTrustFactorResponse

Eksempel

set_trust_factor Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Response

Returnerer: CreateModeratorResponse

Eksempel

create_moderator Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
id	string	path	Ja
sendEmail	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommenteringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: GetModeratorResponse

Eksempel

Eksempel på get_moderator

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Respons

Returnerer: GetModeratorsResponse

Eksempel

get_moderators Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

send_invite Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Respons

Returnerer: APIEmptyResponse

Eksempel

update_moderator Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer autorisation for API-nøgle: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Navn	Type	Placering	Krævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på delete_notification_count

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Respons

Returnerer: GetCachedNotificationCountResponse

Eksempel

get_cached_notification_count Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
userId	string	query	Nej
urlId	string	query	Nej
fromCommentId	string	query	Nej
viewed	boolean	query	Nej
type	string	query	Nej

Svar

Returnerer: GetNotificationCountResponse

Eksempel

get_notification_count Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
userId	string	query	Nej
urlId	string	query	Nej
fromCommentId	string	query	Nej
viewed	boolean	query	Nej
type	string	query	Nej
skip	number	query	Nej

Svar

Returnerer: GetNotificationsResponse

Eksempel

get_notifications Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

update_notification Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af godkendelse
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	path	Ja
urlId	string	query	Ja
title	string	query	Nej

Svar

Returnerer: CreateV1PageReact

Eksempel

create_v1_page_react Eksempel

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 "Fejl ved kald til PublicApi->create_v1_page_react: #{e}"
end

create_v2_page_react

Parametre

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

Svar

Returnerer: CreateV1PageReact

Eksempel

create_v2_page_react Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	path	Ja
urlId	string	query	Ja

Respons

Returnerer: CreateV1PageReact

Eksempel

Eksempel på delete_v1_page_react

Copy

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

Parametre

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

Svar

Returnerer: CreateV1PageReact

Eksempel

delete_v2_page_react Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	sti	Ja
urlId	string	forespørgsel	Ja

Svar

Returnerer: GetV1PageLikes

Eksempel

get_v1_page_likes Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	sti	Ja
urlId	string	forespørgsel	Ja
id	string	forespørgsel	Ja

Svar

Returnerer: GetV2PageReactUsersResponse

Eksempel

get_v2_page_react_users Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	path	Ja
urlId	string	query	Ja

Svar

Returnerer: GetV2PageReacts

Eksempel

get_v2_page_reacts Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: AddPageAPIResponse

Eksempel

add_page Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to 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

Parametre

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

Svar

Returnerer: DeletePageAPIResponse

Eksempel

delete_page Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar-tegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Tidligere kommentatorer på siden, som IKKE er online lige nu. Sorteret efter displayName. Brug dette efter at have udtømt /users/online for at gengive en "Medlemmer"-sektion. Cursor-paginering på commenterName: serveren gennemgår den delvise {tenantId, urlId, commenterName} indekser fra afterName fremad via $gt, ingen $skip-omkostning.

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Side-URL-identifikator (renset på serversiden).
afterName	string	query	No	Cursor: send nextAfterName fra det forrige svar.
afterUserId	string	query	No	Cursor tiebreaker: send nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så navne-ligheder ikke udelader poster.

Response

Returnerer: PageUsersOfflineResponse

Example

Eksempel på get_offline_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Side-URL-identifikator (renset på serversiden).
opts = {
  after_name: 'after_name_example', # String | Cursor: send nextAfterName fra det forrige svar.
  after_user_id: 'after_user_id_example' # String | Cursor tiebreaker: send nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så navne-ligheder ikke udelader poster.
}
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

Nuværende online-seere af en side: personer hvis websocket-session er tilmeldt siden lige nu. Returnerer anonCount + totalCount (abonnenter for hele rummet, inklusive anonyme seere, som vi ikke opremser).

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Side-URL-identifikator (renset på serversiden).
afterName	string	query	No	Cursor: angiv nextAfterName fra det forrige svar.
afterUserId	string	query	No	Cursor tiebreaker: angiv nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så poster med samme navn ikke bliver udeladt.

Response

Returnerer: PageUsersOnlineResponse

Example

get_online_users Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Side-URL-identifikator (renset på serversiden).
opts = {
  after_name: 'after_name_example', # String | Cursor: angiv nextAfterName fra det forrige svar.
  after_user_id: 'after_user_id_example' # String | Cursor tiebreaker: angiv nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så poster med samme navn ikke bliver udeladt.
}
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

Parametre

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

Svar

Returnerer: GetPageByURLIdAPIResponse

Eksempel

get_page_by_urlid Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: GetPagesAPIResponse

Eksempel

get_pages Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Lister sider for en tenant. Bruges af FChat desktop-klienten til at udfylde dens rumliste. Kræver, at enableFChat er true i den resulterende tilpassede konfiguration for hver side. Sider, der kræver SSO, filtreres i forhold til den anmodende brugers gruppeadgang.

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	path	Ja
cursor	string	query	Nej	Opak pagineringscursor returneret som `nextCursor` fra en tidligere anmodning. Knyttet til samme `sortBy`.
limit	integer	query	Nej	1..200, standard 50
q	string	query	Nej	Valgfrit case-insensitivt titelpræfiksfilter.
sortBy	string	query	Nej	Sorteringsrækkefølge. `updatedAt` (standard, nyeste først), `commentCount` (flest kommentarer først), eller `title` (alfabetisk).
hasComments	boolean	query	Nej	Hvis `true`, returner kun sider med mindst én kommentar.

Svar

Returnerer: GetPublicPagesResponse

Eksempel

get_pages_public Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Opak pagineringscursor returneret som `nextCursor` fra en tidligere anmodning. Knyttet til samme `sortBy`.
  limit: 56, # Integer | 1..200, standard 50
  q: 'q_example', # String | Valgfrit case-insensitivt titelpræfiksfilter.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Sorteringsrækkefølge. `updatedAt` (standard, nyeste først), `commentCount` (flest kommentarer først), eller `title` (alfabetisk).
  has_comments: true # Boolean | Hvis `true`, returner kun sider med mindst én kommentar.
}
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-brugerinfo for en tenant. Givet userIds returneres visningsinfo fra User / SSOUser. Bruges af kommentar-widgeten til at berige brugere, der netop er dukket op via en presence-hændelse. Ingen sidesammenhæng: privatliv håndhæves ensartet (private profiler er maskeret).

Parameters

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	path	Ja
ids	string	query	Ja	Komma-separerede userIds.

Response

Returnerer: PageUsersInfoResponse

Eksempel

get_users_info Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | Komma-separerede 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: PatchPageAPIResponse

Eksempel

patch_page Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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 | 
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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
commentId	string	query	Nej
externalId	string	query	Nej
eventType	string	query	Nej
type	string	query	Nej
domain	string	query	Nej
attemptCountGT	number	query	Nej

Svar

Returnerer: GetPendingWebhookEventCountResponse

Eksempel

get_pending_webhook_event_count Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer autorisation med API-nøgle: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren foran den følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
commentId	string	query	Nej
externalId	string	query	Nej
eventType	string	query	Nej
type	string	query	Nej
domain	string	query	Nej
attemptCountGT	number	query	Nej
skip	number	query	Nej

Svar

Returnerer: GetPendingWebhookEventsResponse

Eksempel

get_pending_webhook_events Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer godkendelse med API-nøgle: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Svar

Returnerer: CreateQuestionConfigResponse

Eksempel

create_question_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_question_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: GetQuestionConfigResponse

Eksempel

get_question_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

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

Svar

Returnerer: GetQuestionConfigsResponse

Eksempel

get_question_configs Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

update_question_config Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: CreateQuestionResultResponse

Eksempel

create_question_result Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Yes
id	string	path	Yes

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_question_result Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. '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 | 
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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: GetQuestionResultResponse

Eksempel

get_question_result Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
urlId	string	query	Nej
userId	string	query	Nej
startDate	string	query	Nej
questionId	string	query	Nej
questionIds	string	query	Nej
skip	number	query	Nej

Svar

Returnerer: GetQuestionResultsResponse

Eksempel

get_question_results Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

update_question_result Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

Svar

Returnerer: AggregateQuestionResultsResponse

Eksempel

aggregate_question_results Example

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: BulkAggregateQuestionResultsResponse

Eksempel

bulk_aggregate_question_results Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
questionId	string	query	Nej
questionIds	array	query	Nej
urlId	string	query	Nej
startDate	string	query	Nej
forceRecalculate	boolean	query	Nej
minValue	number	query	Nej
maxValue	number	query	Nej
limit	number	query	Nej

Svar

Returnerer: CombineQuestionResultsWithCommentsResponse

Eksempel

combine_comments_with_question_results Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Respons

Returnerer: AddSSOUserAPIResponse

Eksempel

Eksempel på add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-autorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
deleteComments	boolean	query	Nej
commentDeleteMode	string	query	Nej

Svar

Returnerer: DeleteSSOUserAPIResponse

Eksempel

delete_sso_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentarstegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: GetSSOUserByEmailAPIResponse

Eksempel

get_sso_user_by_email Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: GetSSOUserByIdAPIResponse

Eksempel

get_sso_user_by_id Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja
skip	integer	query	Nej

Respons

Returnerer: GetSSOUsersResponse

Eksempel

get_sso_users Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
id	string	path	Ja
updateComments	boolean	query	Nej

Svar

Returnerer: PatchSSOUserAPIResponse

Eksempel

patch_sso_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommenteringen af følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
updateComments	boolean	query	Nej

Svar

Returnerer: PutSSOUserAPIResponse

Eksempel

put_sso_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentareringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja

Svar

Returnerer: CreateSubscriptionAPIResponse

Eksempel

create_subscription Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
userId	string	query	Nej

Respons

Returnerer: DeleteSubscriptionAPIResponse

Eksempel

delete_subscription Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

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

Svar

Returnerer: GetSubscriptionsAPIResponse

Eksempel

get_subscriptions Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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

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

Response

Returnerer: UpdateSubscriptionAPIResponse

Eksempel

update_subscription Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
yearNumber	number	query	Nej
monthNumber	number	query	Nej
dayNumber	number	query	Nej
skip	number	query	Nej

Respons

Returnerer: GetTenantDailyUsagesResponse

Eksempel

get_tenant_daily_usages Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (defaults to 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

Parametre

Name	Type	Location	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Svar

Returnerer: CreateTenantPackageResponse

Eksempel

create_tenant_package Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_tenant_package Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: GetTenantPackageResponse

Eksempel

get_tenant_package Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API key-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API key, f.eks. 'Bearer' (standard er 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_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

get_tenant_packages

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
skip	number	query	Nej

Svar

Returnerer: GetTenantPackagesResponse

Eksempel

get_tenant_packages Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Respons

Returnerer: APIEmptyResponse

Eksempel

replace_tenant_package Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på update_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Respons

Returnerer: CreateTenantUserResponse

Eksempel

create_tenant_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Obligatorisk
tenantId	string	query	Ja
id	string	path	Ja
deleteComments	string	query	Nej
commentDeleteMode	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren af følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: GetTenantUserResponse

Eksempel

get_tenant_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Respons

Returnerer: GetTenantUsersResponse

Eksempel

Eksempel på get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

replace_tenant_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
redirectURL	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

Eksempel på send_login_link

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentarstegnet fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptyResponse

Eksempel

update_tenant_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Response

Returnerer: CreateTenantResponse

Eksempel

create_tenant Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
id	string	path	Ja
sure	string	query	Nej

Svar

Returnerer: APIEmptyResponse

Eksempel

delete_tenant Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-autorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Respons

Returnerer: GetTenantResponse

Eksempel

get_tenant Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer autorisation via API-nøgle: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommenteringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
meta	string	query	Nej
skip	number	query	Nej

Svar

Returnerer: GetTenantsResponse

Eksempel

get_tenants Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Respons

Returnerer: APIEmptyResponse

Eksempel

update_tenant Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-autorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
userId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: ChangeTicketStateResponse

Eksempel

change_ticket_state Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: CreateTicketResponse

Eksempel

create_ticket Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
id	string	path	Ja
userId	string	query	Nej

Svar

Returnerer: GetTicketResponse

Eksempel

get_ticket Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
userId	string	query	Nej
state	number	query	Nej
skip	number	query	Nej
limit	number	query	Nej

Svar

Returnerer: GetTicketsResponse

Eksempel

get_tickets Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
namespace	string	path	Ja
component	string	path	Ja
locale	string	query	Nej
useFullTranslationIds	boolean	query	Nej

Respons

Returnerer: GetTranslationsResponse

Eksempel

get_translations Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # Streng | 
component = 'component_example' # Streng | 
opts = {
  locale: 'locale_example', # Streng | 
  use_full_translation_ids: true # Boolesk | 
}
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

Upload og ændre størrelse på et billede

Parametre

Name	Type	Location	Required	Description
tenantId	string	path	Ja
sizePreset	string	query	Nej	Størrelsesforindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser til populære enheder)
urlId	string	query	Nej	Side-id som uploaden sker fra, til konfiguration

Svar

Returnerer: UploadImageResponse

Eksempel

upload_image Eksempel

Copy

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 | Størrelsesforindstilling: \"Default\" (1000x1000px) eller \"CrossPlatform\" (opretter størrelser til populære enheder)
  url_id: 'url_id_example' # String | Side-id som uploaden sker fra, til konfiguration
}
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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIGetUserBadgeProgressResponse

Eksempel

get_user_badge_progress_by_id Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren foran følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
userId	string	path	Ja

Svar

Returnerer: APIGetUserBadgeProgressResponse

Eksempel

get_user_badge_progress_by_user_id Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
userId	string	query	Nej
limit	number	query	Nej
skip	number	query	Nej

Response

Returnerer: APIGetUserBadgeProgressListResponse

Eksempel

get_user_badge_progress_list Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja

Respons

Returnerer: APICreateUserBadgeResponse

Eksempel

create_user_badge Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

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

Svar

Returnerer: APIEmptySuccessResponse

Eksempel

delete_user_badge Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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 | 
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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Respons

Returnerer: APIGetUserBadgeResponse

Eksempel

get_user_badge Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. '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 | 
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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
userId	string	query	Nej
badgeId	string	query	Nej
type	number	query	Nej
displayedOnComments	boolean	query	Nej
limit	number	query	Nej
skip	number	query	Nej

Svar

Returnerer: APIGetUserBadgesResponse

Eksempel

get_user_badges Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisering: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
id	string	path	Ja

Svar

Returnerer: APIEmptySuccessResponse

Eksempel

Eksempel på update_user_badge

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required	Description
tenantId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: GetUserNotificationCountResponse

Eksempel

get_user_notification_count Eksempel

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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
urlId	string	query	Nej	Bruges til at afgøre, om den nuværende side er abonneret.
pageSize	integer	query	Nej
afterId	string	query	Nej
includeContext	boolean	query	Nej
afterCreatedAt	integer	query	Nej
unreadOnly	boolean	query	Nej
dmOnly	boolean	query	Nej
noDm	boolean	query	Nej
includeTranslations	boolean	query	Nej
includeTenantNotifications	boolean	query	Nej
sso	string	query	Nej

Svar

Returnerer: GetMyNotificationsResponse

Eksempel

get_user_notifications Eksempel

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | Bruges til at afgøre, om den nuværende side er abonneret.
  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

Parametre

Name	Type	Location	Påkrævet	Beskrivelse
tenantId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: ResetUserNotificationsResponse

Eksempel

reset_user_notification_count Eksempel

Copy

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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
afterId	string	query	Nej
afterCreatedAt	integer	query	Nej
unreadOnly	boolean	query	Nej
dmOnly	boolean	query	Nej
noDm	boolean	query	Nej
sso	string	query	Nej

Response

Returnerer: ResetUserNotificationsResponse

Eksempel

reset_user_notifications Eksempel

Copy

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

Aktiver eller deaktiver notifikationer for en bestemt kommentar.

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
notificationId	string	path	Ja
optedInOrOut	string	path	Ja
commentId	string	query	Ja
sso	string	query	Nej

Svar

Returnerer: UpdateUserNotificationCommentSubscriptionStatusResponse

Eksempel

update_user_notification_comment_subscription_status Eksempel

Copy

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

Aktivér eller deaktiver notifikationer for en side. Når brugere er abonneret på en side, oprettes der notifikationer for nye rodkommentarer, og også

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
urlId	string	query	Ja
url	string	query	Ja
pageTitle	string	query	Ja
subscribedOrUnsubscribed	string	path	Ja
sso	string	query	Nej

Svar

Returnerer: UpdateUserNotificationPageSubscriptionStatusResponse

Eksempel

update_user_notification_page_subscription_status Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	forespørgsel	Ja
notificationId	string	sti	Ja
newStatus	string	sti	Ja
sso	string	forespørgsel	Nej

Svar

Returnerer: UpdateUserNotificationStatusResponse

Eksempel

update_user_notification_status Eksempel

Copy

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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
urlIdWS	string	query	Ja
userIds	string	query	Ja

Respons

Returnerer: GetUserPresenceStatusesResponse

Eksempel

get_user_presence_statuses Eksempel

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

Parametre

Name	Type	Location	Required
tenantId	string	path	Ja
urlId	string	query	Ja
usernameStartsWith	string	query	Nej
mentionGroupIds	array	query	Nej
sso	string	query	Nej
searchSection	string	query	Nej

Svar

Returnerer: SearchUsersResult

Eksempel

search_users Eksempel

Copy

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

Parametre

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

Respons

Returnerer: GetUserResponse

Eksempel

get_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# Opsæt autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgle-godkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

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

Svar

Returnerer: VoteResponse

Eksempel

create_vote Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Name	Type	Location	Required
tenantId	string	query	Ja
id	string	path	Ja
editKey	string	query	Nej

Svar

Returnerer: VoteDeleteResponse

Eksempel

delete_vote-eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsætning af autorisation
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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

Parametre

Navn	Type	Placering	Påkrævet	Beskrivelse
tenantId	string	query	Ja
urlId	string	query	Ja

Respons

Returnerer: GetVotesResponse

Eksempel

get_votes Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøgleautorisation: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Parametre

Navn	Type	Placering	Påkrævet
tenantId	string	query	Ja
urlId	string	query	Ja
userId	string	query	Nej
anonUserId	string	query	Nej

Svar

Returnerer: GetVotesForUserResponse

Eksempel

get_votes_for_user Eksempel

Copy

require 'time'
require 'fastcomments-client'
# opsæt godkendelse
FastCommentsClient.configure do |config|
  # Konfigurer API-nøglegodkendelse: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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

Brug for hjælp?

Hvis du støder på problemer eller har spørgsmål om Ruby SDK'et, så:

Bidrag

Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.

Sprog 🇩🇰 Dansk

Kom godt i gang

Dokumentation

Brug

Aggregering

Revisionslog

Autentificering

Bloker fra kommentar

Kontroller blokerede kommentarer

Kommentarer

Kommentarer for bruger

Domænekonfigurationer

E-mailskabeloner

Hændelseslog

Feed-indlæg

Marker kommentar

GIF'er

Hashtags

Moderering

Moderatorer

Notifikationstælling

Notifikationer

Side-reaktioner

Sider

Afventende webhook-hændelser

Spørgsmålskonfigurationer

Spørgsmålsresultater

Aggregering af spørsmålsresultater

SSO-brugere

Abonnementer

Dagligt forbrug for lejer

Lejerpakker

Lejerbrugere

Lejere

Sager

Oversættelser

Upload billede

Brugerbadge-fremskridt

Brugerbadges

Brugernotifikationer

Bruger-tilstedeværelsesstatus

Brugersøgning

Brugere

Stemmer

FastComments Ruby SDK

Repository

Installation

Biblioteksindhold

Offentlige vs sikrede API’er

Hurtig start

Brugen af godkendte API'er (DefaultApi)

Brugen af offentlige API'er (PublicApi)

Brugen af moderations-API'er (ModerationApi)

Almindelige problemer

Noter

Broadcast-id'er

SSO (Single Sign-On)

Brug af SSO

Simpel SSO

Sikker SSO

aggregate

Parametre

Svar

Eksempel

get_audit_logs

Parametre

Svar

Eksempel

logout_public

Svar

Eksempel

block_from_comment_public

Parametre

Svar

Eksempel

un_block_comment_public

Parametre

Svar

Eksempel

checked_comments_for_blocked