FastComments - SDK Ruby

Ceci est le SDK Ruby officiel pour FastComments.

SDK Ruby officiel pour l'API FastComments

Dépôt

Installation

Ajoutez cette ligne au Gemfile de votre application :

gem 'fastcomments'

Ensuite, exécutez :

bundle install

Ou installez‑le vous-même avec :

gem install fastcomments

Contenu de la bibliothèque

Cette bibliothèque contient le client API généré et les utilitaires SSO pour faciliter l’utilisation de l’API.

Documentation du client API

API publiques vs sécurisées

Pour le client API, il existe trois classes, DefaultApi, PublicApi et ModerationApi. DefaultApi contient des méthodes qui nécessitent votre clé API, et PublicApi contient des appels API pouvant être effectués directement depuis un navigateur, un appareil mobile, etc., sans authentification. ModerationApi regroupe les méthodes qui alimentent le tableau de bord des modérateurs.

ModerationApi propose une suite étendue d’API de modération en temps réel et rapides. Chaque méthode de ModerationApi accepte un paramètre sso et peut s’authentifier via SSO ou un cookie de session FastComments.com.

Démarrage rapide

Utilisation des API authentifiées (DefaultApi)

Important : Vous devez définir votre clé API sur l'ApiClient avant d'effectuer des requêtes authentifiées. Si vous ne le faites pas, les requêtes échoueront avec une erreur 401.

require 'fastcomments'

# Créez et configurez le client API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# OBLIGATOIRE : définissez votre clé API (obtenez-la depuis votre tableau de bord FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Créez l'instance API avec le client configuré
api = FastCommentsClient::DefaultApi.new(api_client)

# Vous pouvez maintenant effectuer des appels API authentifiés
begin
  # Exemple : ajouter un utilisateur SSO
  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}"
  # Erreurs courantes :
  # - 401 : la clé API est manquante ou invalide
  # - 400 : la validation de la requête a échoué
end

Utilisation des API publiques (PublicApi)

Les points de terminaison publics ne nécessitent pas d'authentification :

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

Utilisation des API de modération (ModerationApi)

Les méthodes de modération alimentent le tableau de bord des modérateurs. Passez un jeton sso afin que la requête soit effectuée au nom d'un modérateur authentifié via SSO :

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Exemple : lister les commentaires dans la file de modération
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Problèmes courants

Erreur 401 "missing-api-key" : Assurez-vous de définir config.api_key['x-api-key'] = 'YOUR_KEY' avant de créer l'instance DefaultApi.
Classe API incorrecte : Utilisez DefaultApi pour les requêtes authentifiées côté serveur, PublicApi pour les requêtes côté client/public, et ModerationApi pour les requêtes du tableau de bord des modérateurs.
Clé API nulle : Le SDK ignorera silencieusement l'authentification si la clé API est nulle, entraînant des erreurs 401.

Notes

Identifiants de diffusion

Vous verrez que vous devez fournir un broadcastId dans certains appels d'API. Lorsque vous recevrez des événements, cet ID vous sera renvoyé, ce qui vous permet d'ignorer l'événement si vous prévoyez d'appliquer les changements de manière optimiste côté client (ce que vous voudrez probablement faire car cela offre la meilleure expérience). Fournissez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois lors d'une session de navigateur.

SSO (authentification unique)

Pour des exemples de SSO, voir ci-dessous.

Utilisation SSO

SSO simple

require 'fastcomments'

# Créer un jeton SSO Simple
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}"

# Utiliser le jeton SSO pour effectuer un appel d'API authentifié
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}"

SSO sécurisé

require 'fastcomments'

# Créer un jeton SSO Sécurisé
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}"

# Utiliser le jeton SSO pour effectuer un appel d'API authentifié
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}"

agréger

Agrège des documents en les groupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
parentTenantId	string	query	Non
includeStats	boolean	query	Non

Réponse

Renvoie: AggregateResponse

Exemple

Exemple d'agrégation

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les journaux d'audit

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
limit	number	query	Non
skip	number	query	Non
order	string	query	Non
after	number	query	Non
before	number	query	Non

Réponse

Renvoie : GetAuditLogsResponse

Exemple

Exemple de get_audit_logs

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

déconnexion publique

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de logout_public

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

bloquer depuis le commentaire public

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
sso	string	query	Non

Réponse

Renvoie : BlockSuccess

Exemple

Exemple de block_from_comment_public

Copy

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

débloquer le commentaire public

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
commentId	string	path	Oui
sso	string	query	Non

Réponse

Renvoie : UnblockSuccess

Exemple

Exemple pour un_block_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.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

vérifier les commentaires bloqués

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
commentIds	string	query	Oui	Une liste d'identifiants de commentaires séparés par des virgules.
sso	string	query	Non

Réponse

Retourne: CheckBlockedCommentsResponse

Exemple

Exemple de checked_comments_for_blocked

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | Une liste d'identifiants de commentaires séparés par des virgules.
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

bloquer l'utilisateur depuis le commentaire

Paramètres

Nom	Type	Location	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Renvoie : BlockSuccess

Exemple

Exemple de block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer commentaire public

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
urlId	string	query	Oui
broadcastId	string	query	Oui
sessionId	string	query	Non
sso	string	query	Non

Réponse

Renvoie : SaveCommentsResponseWithPresence

Exemple

Exemple create_comment_public

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

supprimer le commentaire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
contextUserId	string	query	Non
isLive	boolean	query	Non

Réponse

Renvoie: DeleteCommentResult

Exemple

Exemple de delete_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer commentaire public

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
editKey	string	query	Non
sso	string	query	Non

Réponse

Renvoie: PublicAPIDeleteCommentResponse

Exemple

Exemple de delete_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
broadcast_id = 'broadcast_id_example' # Chaîne | 
opts = {
  edit_key: 'edit_key_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

supprimer le vote du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
commentId	string	path	Oui
voteId	string	path	Oui
urlId	string	query	Oui
broadcastId	string	query	Oui
editKey	string	query	Non
sso	string	query	Non

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple de delete_comment_vote

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
vote_id = 'vote_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
broadcast_id = 'broadcast_id_example' # Chaîne | 
opts = {
  edit_key: 'edit_key_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

signaler le commentaire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Retourne : FlagCommentResponse

Exemple

Exemple de flag_comment

Copy

require 'time'
require 'fastcomments-client'
# configurer l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, ex. 'Bearer' (par défaut 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

obtenir le commentaire

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : APIGetCommentResponse

Exemple

Exemple de get_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (valeur par défaut: 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

obtenir le texte du commentaire

Paramètres

Nom	Type	Location	Obligatoire
tenantId	string	path	Oui
commentId	string	path	Oui
editKey	string	query	Non
sso	string	query	Non

Réponse

Renvoie: PublicAPIGetCommentTextResponse

Exemple

Exemple get_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  edit_key: 'edit_key_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les noms d'utilisateur des votes du commentaire

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
commentId	string	path	Oui
dir	integer	query	Oui
sso	string	query	Non

Réponse

Renvoie : GetCommentVoteUserNamesSuccessResponse

Exemple

Exemple de get_comment_vote_user_names

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
dir = 56 # Entier | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les commentaires

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
page	integer	query	Non
limit	integer	query	Non
skip	integer	query	Non
asTree	boolean	query	Non
skipChildren	integer	query	Non
limitChildren	integer	query	Non
maxTreeDepth	integer	query	Non
urlId	string	query	Non
userId	string	query	Non
anonUserId	string	query	Non
contextUserId	string	query	Non
hashTag	string	query	Non
parentId	string	query	Non
direction	string	query	Non
fromDate	integer	query	Non
toDate	integer	query	Non

Réponse

Renvoie : APIGetCommentsResponse

Exemple

Exemple de get_comments

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut : 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

obtenir les commentaires publics

req tenantId urlId

Paramètres

Name	Type	Emplacement	Obligatoire
tenantId	string	chemin	Oui
urlId	string	requête	Oui
page	integer	requête	Non
direction	string	requête	Non
sso	string	requête	Non
skip	integer	requête	Non
skipChildren	integer	requête	Non
limit	integer	requête	Non
limitChildren	integer	requête	Non
countChildren	boolean	requête	Non
fetchPageForCommentId	string	requête	Non
includeConfig	boolean	requête	Non
countAll	boolean	requête	Non
includei10n	boolean	requête	Non
locale	string	requête	Non
modules	string	requête	Non
isCrawler	boolean	requête	Non
includeNotificationCount	boolean	requête	Non
asTree	boolean	requête	Non
maxTreeDepth	integer	requête	Non
useFullTranslationIds	boolean	requête	Non
parentId	string	requête	Non
searchText	string	requête	Non
hashTags	array	requête	Non
userId	string	requête	Non
customConfigStr	string	requête	Non
afterCommentId	string	requête	Non
beforeCommentId	string	requête	Non

Réponse

Retourne: GetCommentsResponseWithPresencePublicComment

Exemple

Exemple get_comments_public

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

verrouiller le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
sso	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de 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

épingler le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
sso	string	query	Non

Réponse

Renvoie : ChangeCommentPinStatusResponse

Exemple

Exemple de pin_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.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

enregistrer le commentaire

Paramètres

Nom	Type	Location	Obligatoire
tenantId	string	query	Oui
isLive	boolean	query	Non
doSpamCheck	boolean	query	Non
sendEmails	boolean	query	Non
populateNotifications	boolean	query	Non

Réponse

Renvoie: APISaveCommentResponse

Exemple

Exemple de save_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, e.g. 'Bearer' (par défaut 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

enregistrer des commentaires en masse

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
isLive	boolean	query	Non
doSpamCheck	boolean	query	Non
sendEmails	boolean	query	Non
populateNotifications	boolean	query	Non

Réponse

Renvoie: SaveCommentsBulkResponse

Exemple

Exemple de save_comments_bulk

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

définir le texte du commentaire

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
editKey	string	query	Non
sso	string	query	Non

Réponse

Retourne : PublicAPISetCommentTextResponse

Exemple

Exemple de set_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
broadcast_id = 'broadcast_id_example' # Chaîne | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

débloquer l'utilisateur depuis le commentaire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Renvoie: UnblockSuccess

Exemple

Exemple pour un_block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

désigner comme non signalé le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Renvoie: FlagCommentResponse

Exemple

Exemple de un_flag_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, ex. 'Bearer' (par défaut 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

déverrouiller le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	chemin	Oui
commentId	string	chemin	Oui
broadcastId	string	requête	Oui
sso	string	requête	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de un_lock_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
broadcast_id = 'broadcast_id_example' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

désépingler le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
sso	string	query	Non

Réponse

Retourne: ChangeCommentPinStatusResponse

Exemple

Exemple un_pin_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.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

mettre à jour le commentaire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
contextUserId	string	query	Non
doSpamCheck	boolean	query	Non
isLive	boolean	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_comment

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

voter pour le commentaire

Parameters

Name	Type	Location	Required
tenantId	string	path	Oui
commentId	string	path	Oui
urlId	string	query	Oui
broadcastId	string	query	Oui
sessionId	string	query	Non
sso	string	query	Non

Réponse

Renvoie: VoteResponse

Exemple

Exemple de vote_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
broadcast_id = 'broadcast_id_example' # Chaîne | 
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', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les commentaires pour l'utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire
userId	string	query	Non
direction	string	query	Non
repliesToUserId	string	query	Non
page	number	query	Non
includei10n	boolean	query	Non
locale	string	query	Non
isCrawler	boolean	query	Non

Réponse

Renvoie: GetCommentsForUserResponse

Exemple

Exemple de get_comments_for_user

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

ajouter une configuration de domaine

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie: AddDomainConfigResponse

Exemple

Exemple add_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer une configuration de domaine

Paramètres

Name	Type	Location	Obligatoire	Description
tenantId	string	query	Oui
domain	string	path	Oui

Réponse

Retourne: DeleteDomainConfigResponse

Exemple

Exemple de delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

obtenir la configuration de domaine

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
domain	string	path	Oui

Réponse

Renvoie : GetDomainConfigResponse

Exemple

Exemple de get_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les configurations de domaine

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie : GetDomainConfigsResponse

Exemple

Exemple de get_domain_configs

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

modifier la configuration de domaine

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
domainToUpdate	string	path	Oui

Réponse

Retourne: PatchDomainConfigResponse

Exemple

Exemple de patch_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

remplacer la configuration de domaine

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
domainToUpdate	string	path	Oui

Réponse

Renvoie: PutDomainConfigResponse

Exemple

Exemple de put_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un modèle d'e-mail

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Réponse

Retourne : CreateEmailTemplateResponse

Exemple

Exemple de create_email_template

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
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

supprimer un modèle d'e-mail

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne: APIEmptyResponse

Exemple

Exemple de delete_email_template

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

supprimer l'erreur de rendu du modèle d'e-mail

Paramètres

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

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple delete_email_template_render_error

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut : 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

obtenir le modèle d'e-mail

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	requête	Oui
id	string	chemin	Oui

Réponse

Retourne : GetEmailTemplateResponse

Exemple

Exemple de get_email_template

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurez l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, e.g. 'Bearer' (par défaut 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

obtenir les définitions des modèles d'e-mail

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie : GetEmailTemplateDefinitionsResponse

Exemple

Exemple de get_email_template_definitions

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, ex. 'Bearer' (par défaut 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

obtenir les erreurs de rendu des modèles d'e-mail

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
skip	number	query	Non

Réponse

Renvoie : GetEmailTemplateRenderErrorsResponse

Exemple

Exemple de get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configuration de l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les modèles d'e-mail

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
skip	number	query	Non

Réponse

Renvoie: GetEmailTemplatesResponse

Exemple

Exemple get_email_templates

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: 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 | 
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

rendre le modèle d'e-mail

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
locale	string	query	Non

Réponse

Renvoie : RenderEmailTemplateResponse

Exemple

Exemple de render_email_template

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurez l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le modèle d'e-mail

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple update_email_template

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le journal d'événements

req tenantId urlId userIdWS

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
urlId	string	query	Oui
userIdWS	string	query	Oui
startTime	integer	query	Oui
endTime	integer	query	Non

Réponse

Renvoie : GetEventLogResponse

Exemple

Exemple de get_event_log

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

obtenir le journal d'événements global

req tenantId urlId userIdWS

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
urlId	string	query	Oui
userIdWS	string	query	Oui
startTime	integer	query	Oui
endTime	integer	query	Non

Réponse

Renvoie: GetEventLogResponse

Exemple

Exemple de get_global_event_log

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

créer une publication

Paramètres

Nom	Type	Location	Obligatoire
tenantId	string	query	Oui
broadcastId	string	query	Non
isLive	boolean	query	Non
doSpamCheck	boolean	query	Non
skipDupCheck	boolean	query	Non

Réponse

Renvoie : CreateFeedPostsResponse

Exemple

Exemple de create_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer une publication publique

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne: CreateFeedPostResponse

Exemple

Exemple de create_feed_post_public

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

supprimer une publication publique

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
postId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Renvoie: DeleteFeedPostPublicResponse

Exemple

Exemple de delete_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 | 
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

obtenir les publications

req tenantId afterId

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
afterId	string	query	Non
limit	integer	query	Non
tags	array	query	Non

Réponse

Renvoie: GetFeedPostsResponse

Exemple

Exemple get_feed_posts

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

obtenir les publications publiques

req tenantId afterId

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
afterId	string	query	Non
limit	integer	query	Non
tags	array	query	Non
sso	string	query	Non
isCrawler	boolean	query	Non
includeUserInfo	boolean	query	Non

Réponse

Renvoie: PublicFeedPostsResponse

Exemple

Exemple de get_feed_posts_public

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

obtenir les statistiques des publications

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
postIds	array	query	Oui
sso	string	query	Non

Réponse

Renvoie : FeedPostsStatsResponse

Exemple

Exemple de get_feed_posts_stats

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

obtenir les réactions des utilisateurs publiques

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
postIds	array	query	Non
sso	string	query	Non

Réponse

Renvoie : UserReactsResponse

Exemple

get_user_reacts_public Exemple

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

réagir à une publication publique

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
postId	string	path	Oui
isUndo	boolean	query	Non
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Renvoie : ReactFeedPostResponse

Exemple

Exemple de react_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
post_id = 'post_id_example' # Chaîne | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Booléen | 
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

mettre à jour la publication

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

mettre à jour la publication publique

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
postId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Renvoie: CreateFeedPostResponse

Exemple

Exemple de 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

signaler le commentaire public

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
isFlagged	boolean	query	Oui
sso	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple pour flag_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
is_flagged = true # Booléen | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

obtenir le GIF en grand format

Paramètres

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

Réponse

Retourne : GifGetLargeResponse

Exemple

Exemple de get_gif_large

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # Chaîne | 
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

rechercher des gifs

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
search	string	query	Oui
locale	string	query	Non
rating	string	query	Non
page	number	query	Non

Renvoie

Renvoie: GetGifsSearchResponse

Exemple

Exemple de get_gifs_search

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

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	path	Oui
locale	string	query	Non
rating	string	query	Non
page	number	query	Non

Réponse

Renvoie: GetGifsTrendingResponse

Exemple

Exemple de get_gifs_trending

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  locale: 'locale_example', # Chaîne | 
  rating: 'rating_example', # Chaîne | 
  page: 1.2 # Nombre à virgule flottante | 
}
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

ajouter un hashtag

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	requête	Oui

Réponse

Retourne : CreateHashTagResponse

Exemple

Exemple add_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation de la clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (valeur par défaut nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

ajouter des hashtags en masse

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Retourne : BulkCreateHashTagsResponse

Exemple

Exemple add_hash_tags_bulk

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation de la clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un hashtag

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
tag	string	path	Oui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurer l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation de clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
tag = 'tag_example' # Chaîne | 
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

obtenir des hashtags

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
page	number	query	Non

Réponse

Retourne : GetHashTagsResponse

Exemple

Exemple get_hash_tags

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

modifier un hashtag

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
tag	string	path	Oui

Réponse

Retourne : UpdateHashTagResponse

Exemple

patch_hash_tag Exemple

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation de la clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (valeur par défaut 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

supprimer le vote de modération

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple delete_moderation_vote

Copy

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

obtenir les commentaires via l'API

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
page	number	query	Non
count	number	query	Non
text-search	string	query	Non
byIPFromComment	string	query	Non
filters	string	query	Non
searchFilters	string	query	Non
sorts	string	query	Non
demo	boolean	query	Non
sso	string	query	Non

Réponse

Retourne : ModerationAPIGetCommentsResponse

Exemple

Exemple get_api_comments

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  page: 1.2, # Flottant | 
  count: 1.2, # Flottant | 
  text_search: 'text_search_example', # Chaîne | 
  by_ip_from_comment: 'by_ip_from_comment_example', # Chaîne | 
  filters: 'filters_example', # Chaîne | 
  search_filters: 'search_filters_example', # Chaîne | 
  sorts: 'sorts_example', # Chaîne | 
  demo: true, # Booléen | 
  sso: 'sso_example' # Chaîne | 
}
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

obtenir le statut d'export API

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
batchJobId	string	query	Non
sso	string	query	Non

Réponse

Retourne : ModerationExportStatusResponse

Exemple

get_api_export_status Exemple

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

obtenir les IDs API

Paramètres

Nom	Type	Emplacement	Obligatoire
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

Réponse

Retourne : ModerationAPIGetCommentIdsResponse

Exemple

Exemple get_api_ids

Copy

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

obtenir les utilisateurs bannis depuis le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
sso	string	query	Non

Réponse

Retourne : GetBannedUsersFromCommentResponse

Exemple

Exemple get_ban_users_from_comment

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

obtenir le statut de bannissement du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
sso	string	query	Non

Réponse

Retourne : GetCommentBanStatusResponse

Exemple

Exemple get_comment_ban_status

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

obtenir les réponses du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Réponse

Renvoie : ModerationAPIChildCommentsResponse

Exemple

Exemple get_comment_children

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

obtenir le nombre

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

Réponse

Renvoie : ModerationAPICountCommentsResponse

Exemple

Exemple get_count

Copy

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

obtenir les nombres

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes
sso	string	query	No

Réponse

Renvoie : GetBannedUsersCountResponse

Exemple

Exemple get_counts

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

obtenir les journaux

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
sso	string	query	Non

Réponse

Renvoie : ModerationAPIGetLogsResponse

Exemple

Exemple get_logs

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

obtenir les badges manuels

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
sso	string	query	Non

Réponse

Retourne : GetTenantManualBadgesResponse

Exemple

Exemple get_manual_badges

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les badges manuels pour l'utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
badgesUserId	string	query	Non
commentId	string	query	Non
sso	string	query	Non

Réponse

Renvoie : GetUserManualBadgesResponse

Exemple

get_manual_badges_for_user Exemple

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

obtenir le commentaire de modération

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Réponse

Renvoie : ModerationAPICommentResponse

Exemple

Exemple get_moderation_comment

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

obtenir le texte du commentaire de modération

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Réponse

Renvoie : GetCommentTextResponse

Exemple

get_moderation_comment_text Exemple

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

obtenir le résumé pré-bannissement

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
includeByUserIdAndEmail	boolean	query	Non
includeByIP	boolean	query	Non
includeByEmailDomain	boolean	query	Non
sso	string	query	Non

Réponse

Retourne : PreBanSummary

Exemple

Exemple de get_pre_ban_summary

Copy

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

obtenir le résumé de recherche des commentaires

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
value	string	query	Non
filters	string	query	Non
searchFilters	string	query	Non
sso	string	query	Non

Réponse

Retourne : ModerationCommentSearchResponse

Exemple

Exemple get_search_comments_summary

Copy

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

obtenir les pages de recherche

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

Réponse

Retourne : ModerationPageSearchResponse

Exemple

get_search_pages Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  value: 'value_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les sites de recherche

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
value	string	query	Non
sso	string	query	Non

Réponse

Renvoie : ModerationSiteSearchResponse

Exemple

Exemple get_search_sites

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

obtenir les suggestions de recherche

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
text-search	string	query	Non
sso	string	query	Non

Réponse

Retourne : ModerationSuggestResponse

Exemple

Exemple de get_search_suggest

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 "Erreur lors de l'appel de ModerationApi->get_search_suggest : #{e}"
end

obtenir les utilisateurs recherchés

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
value	string	query	Non
sso	string	query	Non

Réponse

Renvoie : ModerationUserSearchResponse

Exemple

get_search_users Exemple

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

obtenir le facteur de confiance

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

Réponse

Renvoie : GetUserTrustFactorResponse

Exemple

Exemple get_trust_factor

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

obtenir la préférence de bannissement de l'utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
sso	string	query	Non

Réponse

Renvoie : APIModerateGetUserBanPreferencesResponse

Exemple

get_user_ban_preference Exemple

Copy

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

obtenir le profil interne de l'utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	query	No
sso	string	query	No

Réponse

Renvoie : GetUserInternalProfileResponse

Exemple

Exemple get_user_internal_profile

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

ajuster les votes des commentaires

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : AdjustVotesResponse

Exemple

Exemple post_adjust_comment_votes

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

demander un export API

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Réponse

Retourne : ModerationExportResponse

Exemple

post_api_export Exemple

Copy

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

bannir l'utilisateur depuis le commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
banEmail	boolean	query	Non
banEmailDomain	boolean	query	Non
banIP	boolean	query	Non
deleteAllUsersComments	boolean	query	Non
bannedUntil	string	query	Non
isShadowBan	boolean	query	Non
updateId	string	query	Non
banReason	string	query	Non
sso	string	query	Non

Réponse

Retourne : BanUserFromCommentResult

Exemple

post_ban_user_from_comment Exemple

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

annuler le bannissement de l'utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes
sso	string	query	No

Réponse

Renvoie : APIEmptyResponse

Exemple

post_ban_user_undo Exemple

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

soumettre un résumé pré-bannissement en masse

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
includeByUserIdAndEmail	boolean	query	Non
includeByIP	boolean	query	Non
includeByEmailDomain	boolean	query	Non
sso	string	query	Non

Réponse

Renvoie : BulkPreBanSummary

Exemple

Exemple post_bulk_pre_ban_summary

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

poster des commentaires par ID

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes
sso	string	query	No

Réponse

Retourne : ModerationAPIChildCommentsResponse

Exemple

Exemple post_comments_by_ids

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

signaler le commentaire (POST)

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

post_flag_comment Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

supprimer le commentaire (POST)

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : PostRemoveCommentApiResponse

Exemple

post_remove_comment Exemple

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

restaurer le commentaire supprimé

Paramètres

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

Réponse

Retourne : APIEmptyResponse

Exemple

post_restore_deleted_comment Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

définir le statut d'approbation du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
approved	boolean	query	Non
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : SetCommentApprovedResponse

Exemple

Exemple post_set_comment_approval_status

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

définir le statut de révision du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
reviewed	boolean	query	Non
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple post_set_comment_review_status

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

définir le statut de spam du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
spam	boolean	query	Non
permNotSpam	boolean	query	Non
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de post_set_comment_spam_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  spam: true, # Booléen | 
  perm_not_spam: true, # Booléen | 
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

définir le texte du commentaire (POST)

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
commentId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : SetCommentTextResponse

Exemple

post_set_comment_text Exemple

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

annuler le signalement du commentaire

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	path	Oui
broadcastId	string	query	Non
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

post_un_flag_comment Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

voter (POST)

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
direction	string	query	No
broadcastId	string	query	No
sso	string	query	No

Réponse

Retourne : VoteResponse

Exemple

post_vote Exemple

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

attribuer un badge

Parameters

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
badgeId	string	query	Oui
userId	string	query	Non
commentId	string	query	Non
broadcastId	string	query	Non
sso	string	query	Non

Response

Retourne : AwardUserBadgeResponse

Example

Exemple put_award_badge

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

fermer la discussion

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
urlId	string	query	Oui
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple put_close_thread

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

retirer un badge

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Réponse

Retourne : RemoveUserBadgeResponse

Exemple

put_remove_badge Exemple

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

rouvrir la discussion

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
urlId	string	query	Oui
sso	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

put_reopen_thread Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

définir le facteur de confiance

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
userId	string	query	Non
trustFactor	string	query	Non
sso	string	query	Non

Réponse

Returns: SetUserTrustFactorResponse

Exemple

Exemple set_trust_factor

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  trust_factor: 'trust_factor_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.set_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Erreur lors de l'appel de ModerationApi->set_trust_factor : #{e}"
end

créer un modérateur

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	requête	Oui

Réponse

Renvoie : CreateModeratorResponse

Exemple

Exemple de create_moderator

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un modérateur

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
sendEmail	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : 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 | 
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

obtenir le modérateur

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne: GetModeratorResponse

Exemple

Exemple get_moderator

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: 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_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

obtenir les modérateurs

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
skip	number	query	Non

Réponse

Renvoie : GetModeratorsResponse

Exemple

Exemple de get_moderators

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, e.g. 'Bearer' (par défaut 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

envoyer une invitation

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
fromName	string	query	Oui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de send_invite

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le modérateur

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple update_moderator

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer le nombre de notifications

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le nombre de notifications en cache

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne: GetCachedNotificationCountResponse

Exemple

Exemple de get_cached_notification_count

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le nombre de notifications

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
userId	string	query	Non
urlId	string	query	Non
fromCommentId	string	query	Non
viewed	boolean	query	Non
type	string	query	Non

Réponse

Renvoie: GetNotificationCountResponse

Exemple

Exemple de get_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (valeur par défaut : 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

obtenir les notifications

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
userId	string	query	Non
urlId	string	query	Non
fromCommentId	string	query	Non
viewed	boolean	query	Non
type	string	query	Non
skip	number	query	Non

Réponse

Renvoie : GetNotificationsResponse

Exemple

Exemple de get_notifications

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

mettre à jour la notification

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de update_notification

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

créer une réaction de page v1

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	chemin	Oui
urlId	string	requête	Oui
title	string	requête	Non

Réponse

Retourne: CreateV1PageReact

Exemple

Exemple de create_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 | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v1_page_react: #{e}"
end

créer une réaction de page v2

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
urlId	string	query	Oui
id	string	query	Oui
title	string	query	Non

Réponse

Renvoie: CreateV1PageReact

Exemple

Exemple de create_v2_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
id = 'id_example' # Chaîne | 
opts = {
  title: 'title_example' # Chaîne | 
}
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

supprimer une réaction de page v1

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	path	Oui
urlId	string	query	Oui

Réponse

Renvoie: CreateV1PageReact

Exemple

Exemple delete_v1_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
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

supprimer une réaction de page v2

Paramètres

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

Réponse

Renvoie : CreateV1PageReact

Exemple

Exemple de delete_v2_page_react

Copy

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

obtenir les likes de page v1

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	chemin	Oui
urlId	string	requête	Oui

Réponse

Renvoie : GetV1PageLikes

Exemple

Exemple get_v1_page_likes

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
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

obtenir les utilisateurs réactifs de la page v2

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
urlId	string	query	Oui
id	string	query	Oui

Réponse

Retourne : GetV2PageReactUsersResponse

Exemple

Exemple de get_v2_page_react_users

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

obtenir les réactions de page v2

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	path	Oui
urlId	string	query	Oui

Réponse

Renvoie : GetV2PageReacts

Exemple

Exemple de get_v2_page_reacts

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

ajouter une page

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie : AddPageAPIResponse

Exemple

Exemple add_page

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer une page

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie: DeletePageAPIResponse

Exemple

Exemple de delete_page

Copy

require 'time'
require 'fastcomments-client'
# configurer l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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 "Erreur lors de l'appel de DefaultApi->delete_page : #{e}"
end

obtenir les utilisateurs hors ligne

Commentateurs précédents sur la page qui ne sont PAS actuellement en ligne. Triés par displayName. Utilisez ceci après avoir épuisé /users/online pour afficher une section "Membres". Pagination par curseur sur commenterName : le serveur parcourt l'index partiel {tenantId, urlId, commenterName} à partir de afterName en avant via $gt, sans coût $skip.

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Identifiant de l'URL de la page (nettoyé côté serveur).
afterName	string	query	No	Curseur : transmettre nextAfterName depuis la réponse précédente.
afterUserId	string	query	No	Tiebreaker de curseur : transmettre nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom n'entraînent pas la suppression d'entrées.

Réponse

Retourne : PageUsersOfflineResponse

Exemple

Exemple 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 | Identifiant de l'URL de la page (nettoyé côté serveur).
opts = {
  after_name: 'after_name_example', # String | Curseur : transmettre nextAfterName depuis la réponse précédente.
  after_user_id: 'after_user_id_example' # String | Tiebreaker de curseur : transmettre nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom n'entraînent pas la suppression d'entrées.
}
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

obtenir les utilisateurs en ligne

Spectateurs actuellement en ligne d'une page : personnes dont la session websocket est abonnée à la page en ce moment. Renvoie anonCount + totalCount (abonnés de la salle dans son ensemble, y compris les spectateurs anonymes que nous n'énumérons pas).

Paramètres

Name	Type	Location	Required	Description
tenantId	string	path	Oui
urlId	string	query	Oui	Identifiant de l'URL de la page (nettoyé côté serveur).
afterName	string	query	Non	Curseur : passer nextAfterName depuis la réponse précédente.
afterUserId	string	query	Non	Critère de départage du curseur : passer nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom n'entraînent pas la perte d'entrées.

Réponse

Renvoie : PageUsersOnlineResponse

Exemple

Exemple de get_online_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Identifiant de l'URL de la page (nettoyé côté serveur).
opts = {
  after_name: 'after_name_example', # String | Curseur : transmettre nextAfterName depuis la réponse précédente.
  after_user_id: 'after_user_id_example' # String | Critère de départage du curseur : transmettre nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom n'entraînent pas la perte d'entrées.
}
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

obtenir la page par URL ID

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes
urlId	string	query	Yes

Réponse

Renvoie: GetPageByURLIdAPIResponse

Exemple

Exemple de get_page_by_urlid

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut: 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

obtenir les pages

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie: GetPagesAPIResponse

Exemple

Exemple pour get_pages

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les pages publiques

Lister les pages pour un tenant. Utilisé par le client de bureau FChat pour remplir sa liste de salons. Nécessite que enableFChat soit true dans la configuration personnalisée résolue pour chaque page. Les pages qui nécessitent un SSO sont filtrées en fonction de l'accès par groupe de l'utilisateur demandeur.

Paramètres

Name	Type	Location	Required	Description
tenantId	string	path	Oui
cursor	string	query	Non	Curseur opaque de pagination renvoyé comme `nextCursor` par une requête précédente. Lié au même `sortBy`.
limit	integer	query	Non	1..200, par défaut 50
q	string	query	Non	Filtre optionnel de préfixe de titre insensible à la casse.
sortBy	string	query	Non	Ordre de tri. `updatedAt` (par défaut, les plus récents en premier), `commentCount` (le plus de commentaires en premier) ou `title` (alphabétique).
hasComments	boolean	query	Non	Si true, ne renvoie que les pages ayant au moins un commentaire.

Réponse

Renvoie : GetPublicPagesResponse

Exemple

Exemple get_pages_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Curseur opaque de pagination renvoyé comme `nextCursor` par une requête précédente. Lié au même `sortBy`.
  limit: 56, # Integer | 1..200, par défaut 50
  q: 'q_example', # String | Filtre optionnel de préfixe de titre insensible à la casse.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Ordre de tri. `updatedAt` (par défaut, les plus récents en premier), `commentCount` (le plus de commentaires en premier), ou `title` (alphabétique).
  has_comments: true # Boolean | Si true, ne renvoie que les pages avec au moins un commentaire.
}
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

obtenir les informations des utilisateurs

Informations utilisateur en masse pour un locataire. Étant donné des userIds, renvoie les informations d'affichage depuis User / SSOUser. Utilisé par le widget de commentaires pour enrichir les utilisateurs qui viennent d'apparaître via un événement de présence. Aucun contexte de page : la confidentialité est appliquée de manière uniforme (les profils privés sont masqués).

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	path	Oui
ids	string	query	Oui	userIds délimités par des virgules.

Réponse

Renvoie : PageUsersInfoResponse

Exemple

Exemple de get_users_info

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | userIds délimités par des virgules.
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

modifier la page

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie : PatchPageAPIResponse

Exemple

Exemple de patch_page

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un événement webhook en attente

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le nombre d'événements webhook en attente

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No

Réponse

Renvoie : GetPendingWebhookEventCountResponse

Exemple

Exemple de get_pending_webhook_event_count

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les événements webhook en attente

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	query	Non
externalId	string	query	Non
eventType	string	query	Non
type	string	query	Non
domain	string	query	Non
attemptCountGT	number	query	Non
skip	number	query	Non

Réponse

Retourne: GetPendingWebhookEventsResponse

Exemple

Exemple de get_pending_webhook_events

Copy

require 'time'
require 'fastcomments-client'
# configurer l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer une configuration de question

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Retourne: CreateQuestionConfigResponse

Exemple

Exemple de create_question_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

supprimer une configuration de question

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de delete_question_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir la configuration de question

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie: GetQuestionConfigResponse

Exemple

Exemple get_question_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurez l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les configurations de question

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
skip	number	query	Non

Response

Renvoie : GetQuestionConfigsResponse

Exemple

Exemple get_question_configs

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

mettre à jour la configuration de question

Paramètres

Nom	Type	Location	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de update_question_config

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un résultat de question

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie: CreateQuestionResultResponse

Exemple

Exemple de create_question_result

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un résultat de question

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_question_result

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut : 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

obtenir le résultat de question

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : GetQuestionResultResponse

Exemple

Exemple de get_question_result

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

obtenir les résultats des questions

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
urlId	string	query	Non
userId	string	query	Non
startDate	string	query	Non
questionId	string	query	Non
questionIds	string	query	Non
skip	number	query	Non

Réponse

Retourne : GetQuestionResultsResponse

Exemple

Exemple de get_question_results

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le résultat de question

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de update_question_result

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

agréger les résultats des questions

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
questionId	string	query	Non
questionIds	array	query	Non
urlId	string	query	Non
timeBucket	string	query	Non
startDate	string	query	Non
forceRecalculate	boolean	query	Non

Réponse

Renvoie : AggregateQuestionResultsResponse

Exemple

Exemple de aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, e.g. 'Bearer' (par défaut 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

agrégation en masse des résultats des questions

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
forceRecalculate	boolean	query	Non

Réponse

Renvoie: BulkAggregateQuestionResultsResponse

Exemple

Exemple de bulk_aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

combiner les commentaires avec les résultats des questions

Paramètres

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

Réponse

Retourne: CombineQuestionResultsWithCommentsResponse

Exemple

Exemple de combine_comments_with_question_results

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

ajouter un utilisateur SSO

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Renvoie : AddSSOUserAPIResponse

Exemple

Exemple de add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

supprimer un utilisateur SSO

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
deleteComments	boolean	query	Non
commentDeleteMode	string	query	Non

Réponse

Renvoie : DeleteSSOUserAPIResponse

Exemple

Exemple de delete_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir l'utilisateur SSO par e-mail

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
email	string	path	Oui

Réponse

Retourne: GetSSOUserByEmailAPIResponse

Exemple

Exemple get_sso_user_by_email

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir l'utilisateur SSO par ID

Paramètres

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

Réponse

Renvoie: GetSSOUserByIdAPIResponse

Exemple

Exemple de get_sso_user_by_id

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
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 | 
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

obtenir les utilisateurs SSO

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
skip	integer	query	Non

Réponse

Renvoie : GetSSOUsersResponse

Exemple

Exemple get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

modifier l'utilisateur SSO

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
updateComments	boolean	query	Non

Réponse

Retourne: PatchSSOUserAPIResponse

Exemple

Exemple de patch_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

remplacer l'utilisateur SSO

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

Réponse

Retourne : PutSSOUserAPIResponse

Exemple

Exemple de put_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un abonnement

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateSubscriptionAPIResponse

Exemple

Exemple de create_subscription

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut : 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

supprimer un abonnement

Paramètres

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

Réponse

Renvoie: DeleteSubscriptionAPIResponse

Exemple

Exemple de delete_subscription

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (valeur par défaut : 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

obtenir les abonnements

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
userId	string	query	Non

Réponse

Retourne: GetSubscriptionsAPIResponse

Exemple

Exemple de get_subscriptions

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

mettre à jour l'abonnement

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
id	string	path	Oui
userId	string	query	Non

Réponse

Retourne: UpdateSubscriptionAPIResponse

Exemple

Exemple de update_subscription

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir l'utilisation quotidienne du locataire

Paramètres

Nom	Type	Location	Obligatoire
tenantId	string	query	Oui
yearNumber	number	query	Non
monthNumber	number	query	Non
dayNumber	number	query	Non
skip	number	query	Non

Réponse

Renvoie: GetTenantDailyUsagesResponse

Exemple

Exemple de get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

créer un forfait du locataire

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Retourne: CreateTenantPackageResponse

Exemple

Exemple de create_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un forfait du locataire

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

obtenir le forfait du locataire

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie : GetTenantPackageResponse

Exemple

Exemple get_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les forfaits du locataire

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Yes
skip	number	query	No

Réponse

Renvoie : GetTenantPackagesResponse

Exemple

Exemple de get_tenant_packages

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

remplacer le forfait du locataire

Paramètres

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

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de replace_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le forfait du locataire

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un utilisateur du locataire

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateTenantUserResponse

Exemple

Exemple de create_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

supprimer un utilisateur du locataire

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
id	string	path	Oui
deleteComments	string	query	Non
commentDeleteMode	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir l'utilisateur du locataire

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : GetTenantUserResponse

Exemple

Exemple get_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut : nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
id = 'id_example' # Chaîne | 
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

obtenir les utilisateurs du locataire

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
skip	number	query	Non

Réponse

Renvoie: GetTenantUsersResponse

Exemple

Exemple de get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut 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

remplacer l'utilisateur du locataire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
updateComments	string	query	Non

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de replace_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommenter la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
id	string	path	Oui
redirectURL	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de send_login_link

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

mettre à jour l'utilisateur du locataire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
updateComments	string	query	Non

Réponse

Retourne: APIEmptyResponse

Exemple

Exemple update_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un locataire

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Retourne: CreateTenantResponse

Exemple

Exemple de create_tenant

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

supprimer un locataire

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
sure	string	query	Non

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple delete_tenant

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le locataire

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie : GetTenantResponse

Exemple

Exemple de get_tenant

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les locataires

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	requête	Oui
meta	string	requête	Non
skip	number	requête	Non

Réponse

Renvoie : GetTenantsResponse

Exemple

Exemple de get_tenants

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le locataire

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurer l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

changer l'état du ticket

Paramètres

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

Réponse

Renvoie : ChangeTicketStateResponse

Exemple

Exemple de change_ticket_state

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
user_id = 'user_id_example' # Chaîne | 
id = 'id_example' # Chaîne | 
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

créer un ticket

Paramètres

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

Réponse

Renvoie : CreateTicketResponse

Exemple

create_ticket Exemple

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: 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 | 
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

obtenir le ticket

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Réponse

Renvoie : GetTicketResponse

Exemple

Exemple get_ticket

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
id = 'id_example' # Chaîne | 
opts = {
  user_id: 'user_id_example' # Chaîne | 
}
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

obtenir les tickets

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
userId	string	query	Non
state	number	query	Non
skip	number	query	Non
limit	number	query	Non

Réponse

Retourne : GetTicketsResponse

Exemple

Exemple de get_tickets

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

obtenir les traductions

Paramètres

Nom	Type	Emplacement	Obligatoire
namespace	string	path	Oui
component	string	path	Oui
locale	string	query	Non
useFullTranslationIds	boolean	query	Non

Réponse

Renvoie : GetTranslationsResponse

Exemple

Exemple get_translations

Copy

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

téléverser une image

Téléverser et redimensionner une image

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	path	Oui
sizePreset	string	query	Non	Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires)
urlId	string	query	Non	ID de la page depuis laquelle le téléchargement a lieu, pour la configuration

Réponse

Retourne : UploadImageResponse

Exemple

Exemple de upload_image

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 | Préréglage de taille : \"Default\" (1000x1000px) ou \"CrossPlatform\" (crée des tailles pour les appareils populaires)
  url_id: 'url_id_example' # String | ID de la page depuis laquelle le téléchargement a lieu, pour la configuration
}
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

obtenir la progression du badge utilisateur par ID

Paramètres

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

Réponse

Renvoie : APIGetUserBadgeProgressResponse

Exemple

Exemple de get_user_badge_progress_by_id

Copy

require 'time'
require 'fastcomments-client'
# configurer l'autorisation
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 | 
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

obtenir la progression du badge utilisateur par ID utilisateur

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
userId	string	path	Oui

Réponse

Renvoie: APIGetUserBadgeProgressResponse

Exemple

Exemple de get_user_badge_progress_by_user_id

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir la liste de progression des badges utilisateur

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
userId	string	query	Non
limit	number	query	Non
skip	number	query	Non

Réponse

Renvoie : APIGetUserBadgeProgressListResponse

Exemple

Exemple de get_user_badge_progress_list

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

créer un badge utilisateur

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Réponse

Retourne: APICreateUserBadgeResponse

Exemple

Exemple de create_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
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_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

supprimer un badge utilisateur

Paramètres

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

Réponse

Renvoie: APIEmptySuccessResponse

Exemple

Exemple de delete_user_badge

Copy

require 'time'
require 'fastcomments-client'
# Configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par exemple 'Bearer' (par défaut 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

obtenir le badge utilisateur

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Renvoie : APIGetUserBadgeResponse

Exemple

Exemple de get_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les badges utilisateur

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
userId	string	query	Non
badgeId	string	query	Non
type	number	query	Non
displayedOnComments	boolean	query	Non
limit	number	query	Non
skip	number	query	Non

Réponse

Renvoie: APIGetUserBadgesResponse

Exemple

Exemple de get_user_badges

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

mettre à jour le badge utilisateur

Paramètres

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

Réponse

Renvoie : APIEmptySuccessResponse

Exemple

Exemple update_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API : api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir le nombre de notifications utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
sso	string	query	Non

Réponse

Renvoie: GetUserNotificationCountResponse

Exemple

Exemple de get_user_notification_count

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 "Erreur lors de l'appel de PublicApi->get_user_notification_count : #{e}"
end

obtenir les notifications utilisateur

Paramètres

Name	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
urlId	string	query	Non	Utilisé pour déterminer si la page actuelle est abonnée.
pageSize	integer	query	Non
afterId	string	query	Non
includeContext	boolean	query	Non
afterCreatedAt	integer	query	Non
unreadOnly	boolean	query	Non
dmOnly	boolean	query	Non
noDm	boolean	query	Non
includeTranslations	boolean	query	Non
includeTenantNotifications	boolean	query	Non
sso	string	query	Non

Réponse

Renvoie : GetMyNotificationsResponse

Exemple

Exemple de get_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | Utilisé pour déterminer si la page actuelle est abonnée.
  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

réinitialiser le compteur de notifications utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
sso	string	query	Non

Réponse

Retourne : ResetUserNotificationsResponse

Exemple

Exemple de reset_user_notification_count

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

réinitialiser les notifications utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
afterId	string	query	Non
afterCreatedAt	integer	query	Non
unreadOnly	boolean	query	Non
dmOnly	boolean	query	Non
noDm	boolean	query	Non
sso	string	query	Non

Réponse

Renvoie : ResetUserNotificationsResponse

Exemple

Exemple de reset_user_notifications

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

mettre à jour le statut d'abonnement aux commentaires des notifications utilisateur

Activer ou désactiver les notifications pour un commentaire spécifique.

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
notificationId	string	path	Oui
optedInOrOut	string	path	Oui
commentId	string	query	Oui
sso	string	query	Non

Réponse

Renvoie: UpdateUserNotificationCommentSubscriptionStatusResponse

Exemple

Exemple update_user_notification_comment_subscription_status

Copy

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

mettre à jour le statut d'abonnement aux pages des notifications utilisateur

Activer ou désactiver les notifications pour une page. Lorsque les utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racines, et aussi

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
urlId	string	query	Oui
url	string	query	Oui
pageTitle	string	query	Oui
subscribedOrUnsubscribed	string	path	Oui
sso	string	query	Non

Réponse

Renvoie : UpdateUserNotificationPageSubscriptionStatusResponse

Exemple

Exemple de update_user_notification_page_subscription_status

Copy

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

mettre à jour le statut de notification utilisateur

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
notificationId	string	path	Oui
newStatus	string	path	Oui
sso	string	query	Non

Response

Renvoie: UpdateUserNotificationStatusResponse

Exemple

Exemple de update_user_notification_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
notification_id = 'notification_id_example' # Chaîne | 
new_status = 'read' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
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

obtenir les statuts de présence utilisateur

Paramètres

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

Réponse

Renvoie: GetUserPresenceStatusesResponse

Exemple

Exemple pour get_user_presence_statuses

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

rechercher des utilisateurs

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
urlId	string	query	Oui
usernameStartsWith	string	query	Non
mentionGroupIds	array	query	Non
sso	string	query	Non
searchSection	string	query	Non

Réponse

Renvoie : SearchUsersResult

Exemple

Exemple de search_users

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

obtenir l'utilisateur

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
id	string	path	Oui

Réponse

Retourne : GetUserResponse

Exemple

Exemple get_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

créer un vote

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
commentId	string	query	Oui
direction	string	query	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Retourne: VoteResponse

Exemple

Exemple create_vote

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (defaults to 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

supprimer le vote

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
id	string	path	Oui
editKey	string	query	Non

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple de delete_vote

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'autorisation
FastCommentsClient.configure do |config|
  # Configure l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p.ex. 'Bearer' (par défaut 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

obtenir les votes

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui
urlId	string	query	Oui

Réponse

Renvoie : GetVotesResponse

Exemple

Exemple get_votes

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

obtenir les votes pour l'utilisateur

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Oui
urlId	string	query	Oui
userId	string	query	Non
anonUserId	string	query	Non

Réponse

Renvoie : GetVotesForUserResponse

Exemple

Exemple de get_votes_for_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'autorisation par clé API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, par ex. 'Bearer' (par défaut 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

Besoin d'aide ?

Si vous rencontrez des problèmes ou avez des questions concernant le SDK Ruby, veuillez :

Contribuer

Les contributions sont les bienvenues ! Veuillez consulter le dépôt GitHub pour les consignes de contribution.

Langue 🇫🇷 Français (France)

Prise en main

Documentation

Utilisation

Agrégation

Journaux d'audit

Authentification

Bloquer depuis le commentaire

Vérifier les commentaires bloqués

Commentaires

Commentaires pour l'utilisateur

Configurations de domaine

Modèles d'e-mail

Journal d'événements

Publications

Signalement de commentaire

Gifs

Hashtags

Modération

Modérateurs

Nombre de notifications

Notifications

Réactions de page

Pages

Événements webhook en attente

Configurations de question

Résultats des questions

Agrégation des résultats des questions

Utilisateurs SSO

Abonnements

Utilisation quotidienne du locataire

Forfaits du locataire

Utilisateurs du locataire

Locataires

Tickets

Traductions

Téléverser une image

Progression du badge utilisateur

Badges utilisateur

Notifications utilisateur

Statuts de présence utilisateur

Recherche d'utilisateurs

Utilisateurs

Votes

FastComments - SDK Ruby

Dépôt

Installation

Contenu de la bibliothèque

API publiques vs sécurisées

Démarrage rapide

Utilisation des API authentifiées (DefaultApi)

Utilisation des API publiques (PublicApi)

Utilisation des API de modération (ModerationApi)

Problèmes courants

Notes

Identifiants de diffusion

SSO (authentification unique)

Utilisation SSO

SSO simple

SSO sécurisé

agréger

Paramètres

Réponse

Exemple

obtenir les journaux d'audit

Paramètres

Réponse

Exemple

déconnexion publique

Réponse

Exemple

bloquer depuis le commentaire public

Paramètres

Réponse

Exemple

débloquer le commentaire public

Paramètres

Réponse

Exemple

vérifier les commentaires bloqués