SDK Ruby de FastComments

Ceci est le SDK Ruby officiel pour FastComments.

SDK Ruby officiel pour l'API FastComments

Dépôt

Installation

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

This library contains the generated API client and the SSO utilities to make working with the API easier.

API Client Library Docs

Public vs Secured APIs

For the API client, there are three classes, DefaultApi, PublicApi, and ModerationApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls that can be made directly from a browser/mobile device/etc without authentication. The ModerationApi contains the methods that power the moderator dashboard.

The ModerationApi provides an extensive suite of live and fast moderation APIs. Every ModerationApi method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.

Démarrage rapide

Utilisation des API authentifiées (DefaultApi)

Important : Vous devez définir votre clé d'API sur l'ApiClient avant d'effectuer des requêtes authentifiées. Sinon, 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)

# REQUIS : Définissez votre clé d'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 communes :
  # - 401 : la clé d'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 du modérateur. Transmettez 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 d’attente 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

401 "missing-api-key" error : Assurez-vous de définir config.api_key['x-api-key'] = 'YOUR_KEY' avant de créer l'instance DefaultApi.
Wrong API class : 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 du modérateur.
Null API key : Le SDK ignorera silencieusement l'authentification si la clé d'API est nulle, entraînant des erreurs 401.

Remarques

Identifiants de diffusion

Vous verrez que vous devez passer un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permet d'ignorer l'événement si vous envisagez d'appliquer de manière optimiste des modifications côté client (ce que vous voudrez probablement faire puisque cela offre la meilleure expérience). Fournissez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours 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 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 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}"

aggregate

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

Paramètres

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

get_audit_logs

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'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 = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

logout_public

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

block_from_comment_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

un_block_comment_public

Paramètres

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

Réponse

Retourne: UnblockSuccess

Exemple

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

checked_comments_for_blocked

Paramètres

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

Réponse

Renvoie : CheckBlockedCommentsResponse

Exemple

checked_comments_for_blocked Exemple

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

block_user_from_comment

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: BlockSuccess

Exemple

Exemple de block_user_from_comment

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 | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

create_comment_public

Paramètres

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

delete_comment

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 delete_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 | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

delete_comment_public

Paramètres

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

Réponse

Retourne : 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

delete_comment_vote

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

flag_comment

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: FlagCommentResponse

Exemple

Exemple de flag_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, 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 = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

get_comment

Paramètres

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

Réponse

Renvoie : APIGetCommentResponse

Exemple

Exemple de get_comment

Copy

require 'time'
require 'fastcomments-client'
# configurer 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 | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

get_comment_text

Paramètres

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

Réponse

Renvoie: PublicAPIGetCommentTextResponse

Exemple

Exemple de get_comment_text

Copy

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

get_comment_vote_user_names

Paramètres

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

Réponse

Retourne : 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

get_comments

Paramètres

Name	Type	Location	Required
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

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, 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 = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # Integer | 
  to_date: 789 # Integer | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

get_comments_public

req tenantId urlId

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Oui
urlId	string	query	Oui
page	integer	query	Non
direction	string	query	Non
sso	string	query	Non
skip	integer	query	Non
skipChildren	integer	query	Non
limit	integer	query	Non
limitChildren	integer	query	Non
countChildren	boolean	query	Non
fetchPageForCommentId	string	query	Non
includeConfig	boolean	query	Non
countAll	boolean	query	Non
includei10n	boolean	query	Non
locale	string	query	Non
modules	string	query	Non
isCrawler	boolean	query	Non
includeNotificationCount	boolean	query	Non
asTree	boolean	query	Non
maxTreeDepth	integer	query	Non
useFullTranslationIds	boolean	query	Non
parentId	string	query	Non
searchText	string	query	Non
hashTags	array	query	Non
userId	string	query	Non
customConfigStr	string	query	Non
afterCommentId	string	query	Non
beforeCommentId	string	query	Non

Réponse

Renvoie : GetCommentsResponseWithPresencePublicComment

Exemple

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

lock_comment

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

pin_comment

Paramètres

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

Réponse

Retourne : ChangeCommentPinStatusResponse

Exemple

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

save_comment

Paramètres

Nom	Type	Emplacement	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'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' (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_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

save_comments_bulk

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 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 | 
create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

set_comment_text

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: PublicAPISetCommentTextResponse

Exemple

Exemple de set_comment_text

Copy

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

un_block_user_from_comment

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 : UnblockSuccess

Exemple

Exemple de un_block_user_from_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, 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 | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

un_flag_comment

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 : 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, 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 = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

un_lock_comment

Paramètres

Name	Type	Location	Required
tenantId	string	path	Oui
commentId	string	path	Oui
broadcastId	string	query	Oui
sso	string	query	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' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

un_pin_comment

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

update_comment

Paramètres

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_comment

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, 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

vote_comment

Paramètres

Nom	Type	Emplacement	Obligatoire
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' # String | 
comment_id = 'comment_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

get_comments_for_user

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

add_domain_config

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes

Réponse

Renvoie : AddDomainConfigResponse

Exemple

Exemple add_domain_config

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 | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

delete_domain_config

Paramètres

Name	Type	Location	Required	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 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 | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

get_domain_config

Paramètres

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

Réponse

Renvoie: GetDomainConfigResponse

Exemple

Exemple get_domain_config

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, 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 = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

get_domain_configs

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Retourne: GetDomainConfigsResponse

Exemple

Exemple de get_domain_configs

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, 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 | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

patch_domain_config

Paramètres

Nom	Type	Emplacement	Requis	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, 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 | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

put_domain_config

Paramètres

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

Response

Renvoie : PutDomainConfigResponse

Exemple

Exemple de put_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 | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

create_email_template

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie : 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, 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_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

delete_email_template

Paramètres

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

Réponse

Renvoie : 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, 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 | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

delete_email_template_render_error

Paramètres

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

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de delete_email_template_render_error

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' (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 | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

get_email_template

Paramètres

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

Réponse

Retourne : GetEmailTemplateResponse

Exemple

Exemple get_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 | 
id = 'id_example' # Chaîne | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

get_email_template_definitions

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Retourne : GetEmailTemplateDefinitionsResponse

Exemple

Exemple de get_email_template_definitions

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 | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

get_email_template_render_errors

Paramètres

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

Réponse

Retourne : GetEmailTemplateRenderErrorsResponse

Exemple

Exemple de get_email_template_render_errors

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 | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

get_email_templates

Paramètres

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

Réponse

Retourne: GetEmailTemplatesResponse

Exemple

Exemple de 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'
  # 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' # Chaîne | 
opts = {
  skip: 1.2 # Flottant | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

render_email_template

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui
locale	string	query	Non

Réponse

Retourne : RenderEmailTemplateResponse

Exemple

Exemple de render_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, 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 | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

update_email_template

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_email_template

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 | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

get_event_log

req tenantId urlId userIdWS

Paramètres

Nom	Type	Emplacement	Obligatoire
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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
user_id_ws = 'user_id_ws_example' # Chaîne | 
start_time = 789 # Entier | 
opts = {
  end_time: 789 # Entier | 
}
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

get_global_event_log

req tenantId urlId userIdWS

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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
user_id_ws = 'user_id_ws_example' # Chaîne | 
start_time = 789 # Entier | 
opts = {
  end_time: 789 # Entier | 
}
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

create_feed_post

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	requête	Oui
broadcastId	string	requête	Non
isLive	boolean	requête	Non
doSpamCheck	boolean	requête	Non
skipDupCheck	boolean	requête	Non

Réponse

Retourne : 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, 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 | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

create_feed_post_public

Paramètres

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

Réponse

Renvoie : 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

delete_feed_post_public

Paramètres

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

Réponse

Retourne: 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

get_feed_posts

req tenantId afterId

Paramètres

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

Réponse

Renvoie : GetFeedPostsResponse

Exemple

Exemple de get_feed_posts

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 = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

get_feed_posts_public

req tenantId afterId

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' # Chaîne | 
opts = {
  after_id: 'after_id_example', # Chaîne | 
  limit: 56, # Entier | 
  tags: ['inner_example'], # Tableau<String> | 
  sso: 'sso_example', # Chaîne | 
  is_crawler: true, # Booléen | 
  include_user_info: true # Booléen | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

get_feed_posts_stats

Paramètres

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

Réponse

Retourne : FeedPostsStatsResponse

Exemple

Exemple de get_feed_posts_stats

Copy

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

get_user_reacts_public

Paramètres

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

Réponse

Renvoie: UserReactsResponse

Exemple

Exemple de get_user_reacts_public

Copy

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

react_feed_post_public

Paramètres

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

Réponse

Retourne: ReactFeedPostResponse

Exemple

Exemple de react_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 | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

update_feed_post

Paramètres

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

Réponse

Retourne: APIEmptyResponse

Exemple

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

update_feed_post_public

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	path	Yes
postId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

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' # Chaîne | 
post_id = 'post_id_example' # Chaîne | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

flag_comment_public

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

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

get_gif_large

Paramètres

Nom	Type	Emplacement	Requis	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' # String | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # String | 
begin
  
  result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gif_large: #{e}"
end

get_gifs_search

Paramètres

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

Réponse

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' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

add_hash_tag

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Yes

Réponse

Renvoie : CreateHashTagResponse

Exemple

add_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, 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_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

add_hash_tags_bulk

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie: BulkCreateHashTagsResponse

Exemple

Exemple add_hash_tags_bulk

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, 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 | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

delete_hash_tag

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

delete_hash_tag Exemple

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, 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 | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

get_hash_tags

Paramètres

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

Réponse

Retourne: GetHashTagsResponse

Exemple

Exemple de get_hash_tags

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 = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

patch_hash_tag

Paramètres

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

Réponse

Renvoie : UpdateHashTagResponse

Exemple

Exemple de patch_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, 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 | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

delete_moderation_vote

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

delete_moderation_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 | 
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

get_api_comments

Paramètres

Name	Type	Location	Required
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

Réponse

Renvoie : ModerationAPIGetCommentsResponse

Exemple

Exemple get_api_comments

Copy

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

get_api_export_status

Paramètres

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

Réponse

Renvoie : ModerationExportStatusResponse

Exemple

Exemple get_api_export_status

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

get_api_ids

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
text-search	string	query	Non
byIPFromComment	string	query	Non
filters	string	query	Non
searchFilters	string	query	Non
afterId	string	query	Non
demo	boolean	query	Non
sso	string	query	Non

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' # Chaîne | 
opts = {
  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 | 
  after_id: 'after_id_example', # Chaîne | 
  demo: true, # Booléen | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

get_ban_users_from_comment

Parameters

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

Response

Renvoie : GetBannedUsersFromCommentResponse

Exemple

Exemple get_ban_users_from_comment

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 = {
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
end

get_comment_ban_status

Paramètres

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

Réponse

Renvoie : GetCommentBanStatusResponse

Exemple

get_comment_ban_status 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_comment_ban_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
end

get_comment_children

Paramètres

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

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

get_count

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

get_count Exemple

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

get_counts

Parameters

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

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

get_logs

Paramètres

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

get_manual_badges

Paramètres

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

Réponse

Retourne : GetTenantManualBadgesResponse

Exemple

get_manual_badges 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_manual_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges: #{e}"
end

get_manual_badges_for_user

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

get_moderation_comment

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' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  include_email: true, # Booléen | 
  include_ip: true, # Booléen | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
end

get_moderation_comment_text

Paramètres

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

Réponse

Retourne : GetCommentTextResponse

Exemple

Exemple get_moderation_comment_text

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 = {
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
end

get_pre_ban_summary

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

Renvoie : PreBanSummary

Exemple

get_pre_ban_summary 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 = {
  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

get_search_comments_summary

Paramètres

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

Réponse

Renvoie : 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

get_search_pages

Paramètres

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

Réponse

Renvoie : ModerationPageSearchResponse

Exemple

Exemple get_search_pages

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

get_search_sites

Paramètres

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

get_search_suggest

Paramètres

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

Réponse

Renvoie : ModerationSuggestResponse

Exemple

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

get_search_users

Paramètres

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

Réponse

Renvoie : ModerationUserSearchResponse

Exemple

Exemple get_search_users

Copy

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

get_trust_factor

Paramètres

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

Réponse

Renvoie : GetUserTrustFactorResponse

Exemple

get_trust_factor Exemple

Copy

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

get_user_ban_preference

Paramètres

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

Réponse

Renvoie : APIModerateGetUserBanPreferencesResponse

Exemple

Exemple de get_user_ban_preference

Copy

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

get_user_internal_profile

Paramètres

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

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

post_adjust_comment_votes

Paramètres

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

Réponse

Renvoie : AdjustVotesResponse

Exemple

Exemple post_adjust_comment_votes

Copy

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

post_api_export

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Oui
text-search	string	query	Non
byIPFromComment	string	query	Non
filters	string	query	Non
searchFilters	string	query	Non
sorts	string	query	Non
sso	string	query	Non

Réponse

Renvoie : ModerationExportResponse

Exemple

post_api_export Exemple

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Chaîne | 
opts = {
  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 | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Erreur lors de l'appel de ModerationApi->post_api_export : #{e}"
end

post_ban_user_from_comment

Paramètres

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

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' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  ban_email: true, # Booléen | 
  ban_email_domain: true, # Booléen | 
  ban_ip: true, # Booléen | 
  delete_all_users_comments: true, # Booléen | 
  banned_until: 'banned_until_example', # Chaîne | 
  is_shadow_ban: true, # Booléen | 
  update_id: 'update_id_example', # Chaîne | 
  ban_reason: 'ban_reason_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
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

post_ban_user_undo

Paramètres

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

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' # Chaîne | 
ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
end

post_bulk_pre_ban_summary

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

post_comments_by_ids

Paramètres

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

Réponse

Renvoie : 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

post_flag_comment

Paramètres

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

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

post_remove_comment

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: PostRemoveCommentApiResponse

Exemple

Exemple post_remove_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 = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_remove_comment: #{e}"
end

post_restore_deleted_comment

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

post_restore_deleted_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_restore_deleted_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
end

post_set_comment_approval_status

Paramètres

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

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

post_set_comment_review_status

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' # Chaîne | 
comment_id = 'comment_id_example' # Chaîne | 
opts = {
  reviewed: true, # Booléen | 
  broadcast_id: 'broadcast_id_example', # Chaîne | 
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_review_status: #{e}"
end

post_set_comment_spam_status

Paramètres

Nom	Type	Emplacement	Obligatoire
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple post_set_comment_spam_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 = {
  spam: true, # Boolean | 
  perm_not_spam: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
end

post_set_comment_text

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 : 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

post_un_flag_comment

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

post_un_flag_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_un_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
end

post_vote

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

Renvoie : 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

put_award_badge

Parameters

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

Renvoie : 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

put_close_thread

Paramètres

Nom	Type	Emplacement	Requis
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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.put_close_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_close_thread: #{e}"
end

put_remove_badge

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

Renvoie : 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

put_reopen_thread

Paramètres

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

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de put_reopen_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_reopen_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
end

set_trust_factor

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

Réponse

Renvoie : SetUserTrustFactorResponse

Exemple

set_trust_factor Exemple

Copy

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

create_moderator

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateModeratorResponse

Exemple

Exemple de create_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, 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_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

delete_moderator

Paramètres

Name	Type	Location	Required
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'
  # 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 = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

get_moderator

Paramètres

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

Réponse

Retourne: GetModeratorResponse

Exemple

Exemple de 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'
  # 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 | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

get_moderators

Paramètres

Name	Type	Location	Required	Description
tenantId	string	requête	Oui
skip	number	requête	Non

Réponse

Retourne : GetModeratorsResponse

Exemple

Exemple de get_moderators

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 | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

send_invite

Paramètres

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

Réponse

Renvoie: APIEmptyResponse

Exemple

Exemple de send_invite

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, 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 | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

update_moderator

Paramètres

Nom	Type	Emplacement	Obligatoire	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|
  # 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 | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

delete_notification_count

Paramètres

Nom	Type	Emplacement	Obligatoire	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, 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' # Chaîne | 
id = 'id_example' # Chaîne | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

get_cached_notification_count

Paramètres

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

Réponse

Renvoie : GetCachedNotificationCountResponse

Exemple

Exemple de get_cached_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, 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 | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

get_notification_count

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' (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 | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  url_id: 'url_id_example', # Chaîne | 
  from_comment_id: 'from_comment_id_example', # Chaîne | 
  viewed: true, # Booléen | 
  type: 'type_example' # Chaîne | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

get_notifications

Paramètres

Nom	Type	Emplacement	Obligatoire
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'
# Mise en place 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' # Chaîne | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  url_id: 'url_id_example', # Chaîne | 
  from_comment_id: 'from_comment_id_example', # Chaîne | 
  viewed: true, # Booléen | 
  type: 'type_example', # Chaîne | 
  skip: 1.2 # Nombre à virgule flottante | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

update_notification

Paramètres

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

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de update_notification

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 | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

create_v1_page_react

Paramètres

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

Réponse

Renvoie : CreateV1PageReact

Exemple

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

create_v2_page_react

Paramètres

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

Réponse

Retourne : CreateV1PageReact

Exemple

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

delete_v1_page_react

Paramètres

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

Réponse

Retourne: CreateV1PageReact

Exemple

Exemple d'utilisation de delete_v1_page_react

Copy

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

delete_v2_page_react

Paramètres

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

get_v1_page_likes

Paramètres

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

Réponse

Retourne : GetV1PageLikes

Exemple

Exemple de get_v1_page_likes

Copy

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

get_v2_page_react_users

Paramètres

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

Réponse

Renvoie: 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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
id = 'id_example' # Chaîne | 
begin
  
  result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
end

get_v2_page_reacts

Paramètres

Nom	Type	Location	Requis	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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
begin
  
  result = api_instance.get_v2_page_reacts(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
end

add_page

Paramètres

Nom	Type	Emplacement	Requis	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|
  # 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_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

delete_page

Paramètres

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

Réponse

Retourne : DeletePageAPIResponse

Exemple

Exemple de delete_page

Copy

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

get_offline_users

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 "Members". Pagination par curseur sur commenterName : le serveur parcourt l'index partiel {tenantId, urlId, commenterName} depuis afterName vers l'avant via $gt, sans coût $skip.

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 : passez nextAfterName depuis la réponse précédente.
afterUserId	string	query	Non	Départageur de curseur : passez nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de noms n'entraînent pas la perte d'entrées.

Réponse

Renvoie : PageUsersOfflineResponse

Exemple

Exemple de 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 : passez nextAfterName depuis la réponse précédente.
  after_user_id: 'after_user_id_example' # String | Départageur de curseur : passez nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de noms n'entraînent pas la perte 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

get_online_users

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Paramètres

Name	Type	Location	Required	Description
tenantId	string	path	Oui
urlId	string	query	Oui	Page URL identifier (cleaned server-side).
afterName	string	query	Non	Curseur : passez nextAfterName depuis la réponse précédente.
afterUserId	string	query	Non	Tie-breaker du curseur : passez nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les entrées avec le même nom ne soient pas perdues.

Réponse

Retourne : 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 : passez nextAfterName depuis la réponse précédente.
  after_user_id: 'after_user_id_example' # String | Tie-breaker du curseur : passez nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les entrées avec le même nom ne soient pas perdues.
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

get_page_by_urlid

Paramètres

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

Réponse

Retourne: GetPageByURLIdAPIResponse

Exemple

get_page_by_urlid 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'
  # 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' # Chaîne | 
url_id = 'url_id_example' # Chaîne | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

get_pages

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Retourne : GetPagesAPIResponse

Exemple

Exemple de 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, 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 | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

get_pages_public

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

Paramètres

Name	Type	Location	Required	Description
tenantId	string	path	Yes
cursor	string	query	No	Curseur de pagination opaque renvoyé comme `nextCursor` d'une requête précédente. Lié au même `sortBy`.
limit	integer	query	No	1..200, par défaut 50
q	string	query	No	Filtre de préfixe de titre optionnel insensible à la casse.
sortBy	string	query	No	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	No	Si vrai, ne retourner que les pages ayant au moins un commentaire.

Réponse

Retourne: GetPublicPagesResponse

Exemple

Exemple de 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 de pagination opaque renvoyé comme `nextCursor` d'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 de préfixe de titre optionnel 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 vrai, ne retourner 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

get_users_info

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

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	chemin	Oui
ids	string	requête	Oui	userIds séparé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 séparé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

patch_page

Paramètres

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

Réponse

Retourne: PatchPageAPIResponse

Exemple

Exemple de patch_page

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, 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 | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

delete_pending_webhook_event

Paramètres

Nom	Type	Emplacement	Obligatoire	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é d'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é d'API, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

get_pending_webhook_event_count

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

Réponse

Renvoie : GetPendingWebhookEventCountResponse

Exemple

get_pending_webhook_event_count 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'
  # 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 = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

get_pending_webhook_events

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

Renvoie : GetPendingWebhookEventsResponse

Exemple

Exemple de get_pending_webhook_events

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 = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

create_question_config

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateQuestionConfigResponse

Exemple

Exemple de create_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, 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_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

delete_question_config

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de delete_question_config

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 | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

get_question_config

Paramètres

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

Réponse

Renvoie: GetQuestionConfigResponse

Exemple

Exemple de get_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, 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 | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

get_question_configs

Paramètres

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

Réponse

Renvoie : GetQuestionConfigsResponse

Exemple

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

update_question_config

Paramètres

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

Réponse

Renvoie: 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, 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 | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

create_question_result

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateQuestionResultResponse

Exemple

Exemple de create_question_result

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 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_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

delete_question_result

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, 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 | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

get_question_result

Paramètres

Nom	Type	Emplacement	Requis	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'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.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

get_question_results

Paramètres

Nom	Type	Emplacement	Obligatoire
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|
  # 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 = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

update_question_result

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple d'update_question_result

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, 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 | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

aggregate_question_results

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, 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 = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

bulk_aggregate_question_results

Paramètres

Name	Type	Location	Required	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, 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 | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combine_comments_with_question_results

Paramètres

Nom	Type	Emplacement	Requis
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, 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 = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

add_sso_user

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Retourne: AddSSOUserAPIResponse

Exemple

Exemple add_sso_user

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, 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

delete_sso_user

Paramètres

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

Réponse

Renvoie: DeleteSSOUserAPIResponse

Exemple

Exemple delete_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 | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

get_sso_user_by_email

Paramètres

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

Réponse

Renvoie: GetSSOUserByEmailAPIResponse

Exemple

Exemple de get_sso_user_by_email

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 | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

get_sso_user_by_id

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	paramètre de requête	Oui
id	string	chemin	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

get_sso_users

Paramètres

Nom	Type	Emplacement	Requis	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'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' # Chaîne | 
opts = {
  skip: 56 # Entier | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

patch_sso_user

Paramètres

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

Réponse

Renvoie : 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, 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 | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

put_sso_user

Paramètres

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

Réponse

Renvoie : PutSSOUserAPIResponse

Exemple

Exemple de put_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configuration de l'authentification
FastCommentsClient.configure do |config|
  # Configurer l'authentification par API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Décommentez la ligne suivante pour définir un préfixe pour l'API key, 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 "Erreur lors de l'appel de DefaultApi->put_sso_user : #{e}"
end

create_subscription

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	requête	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 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 | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

delete_subscription

Paramètres

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

Réponse

Renvoie : DeleteSubscriptionAPIResponse

Exemple

Exemple de delete_subscription

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 | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

get_subscriptions

Paramètres

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

update_subscription

Paramètres

Name	Type	Location	Required
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'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, 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 | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

get_tenant_daily_usages

Paramètres

Nom	Type	Emplacement	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|
  # 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 = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

create_tenant_package

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie : 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, 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_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

delete_tenant_package

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'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_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

get_tenant_package

Paramètres

Nom	Type	Emplacement	Requis	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'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_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

get_tenant_packages

Paramètres

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

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, 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_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

replace_tenant_package

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'
# configurer l'autorisation
FastCommentsClient.configure do |config|
  # Configure API key authorization: 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, 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 | 
replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

update_tenant_package

Paramètres

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

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de update_tenant_package

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, 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 | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

create_tenant_user

Paramètres

Name	Type	Location	Required	Description
tenantId	string	query	Oui

Réponse

Renvoie : CreateTenantUserResponse

Exemple

Exemple de create_tenant_user

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, 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

delete_tenant_user

Paramètres

Nom	Type	Emplacement	Obligatoire
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'
# 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, 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 = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

get_tenant_user

Paramètres

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

Réponse

Renvoie : GetTenantUserResponse

Exemple

Exemple get_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é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_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

get_tenant_users

Paramètres

Name	Type	Location	Required	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'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' (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 = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

replace_tenant_user

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'
# 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 | 
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'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 = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

update_tenant_user

Paramètres

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

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de update_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é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 | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

create_tenant

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Response

Renvoie: 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, 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 | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

delete_tenant

Paramètres

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

Réponse

Retourne: APIEmptyResponse

Exemple

Exemple de delete_tenant

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 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 = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

get_tenant

Paramètres

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

Réponse

Retourne : GetTenantResponse

Exemple

Exemple de get_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, 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 | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

get_tenants

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	paramètre de requête	Oui
meta	string	paramètre de requête	Non
skip	number	paramètre de requête	Non

Réponse

Renvoie : GetTenantsResponse

Exemple

Exemple de get_tenants

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 = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

update_tenant

Paramètres

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

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple update_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, 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 | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

change_ticket_state

Paramètres

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

Réponse

Retourne : ChangeTicketStateResponse

Exemple

Exemple de change_ticket_state

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, 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 | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

create_ticket

Paramètres

Nom	Type	Emplacement	Obligatoire	Description
tenantId	string	query	Oui
userId	string	query	Oui

Réponse

Renvoie : CreateTicketResponse

Exemple

Exemple de create_ticket

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 | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

get_ticket

Paramètres

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

Réponse

Retourne: GetTicketResponse

Exemple

Exemple de 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, 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 = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

get_tickets

Paramètres

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

Réponse

Renvoie : 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

get_translations

Paramètres

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

Réponse

Renvoie : GetTranslationsResponse

Exemple

Exemple de get_translations

Copy

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

upload_image

Téléverser et redimensionner une image

Paramètres

Name	Type	Location	Required	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	Identifiant de la page d'où provient le téléversement, 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 | Identifiant de la page d'où provient le téléversement, 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

get_user_badge_progress_by_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'
# 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 | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

get_user_badge_progress_by_user_id

Paramètres

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

Réponse

Retourne: 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
  # Décommentez la ligne suivante pour définir un préfixe pour la clé API, p. ex. 'Bearer' (par défaut nil)
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

get_user_badge_progress_list

Paramètres

Nom	Type	Emplacement	Obligatoire
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'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 | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

create_user_badge

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	query	Oui

Réponse

Renvoie : APICreateUserBadgeResponse

Exemple

Exemple de create_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, 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_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

delete_user_badge

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'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 | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

get_user_badge

Paramètres

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

Réponse

Retourne : 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' # Chaîne | 
id = 'id_example' # Chaîne | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

get_user_badges

Paramètres

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

Retourne : APIGetUserBadgesResponse

Exemple

Exemple de get_user_badges

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, 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' # Chaîne | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  badge_id: 'badge_id_example', # Chaîne | 
  type: 1.2, # Flottant | 
  displayed_on_comments: true, # Booléen | 
  limit: 1.2, # Flottant | 
  skip: 1.2 # Flottant | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

update_user_badge

Paramètres

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

Réponse

Renvoie : APIEmptySuccessResponse

Exemple

Exemple de 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, 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 | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

get_user_notification_count

Paramètres

Nom	Type	Emplacement	Requis	Description
tenantId	string	requête	Oui
sso	string	requête	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' # Chaîne | 
opts = {
  sso: 'sso_example' # Chaîne | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

get_user_notifications

Paramètres

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

reset_user_notification_count

Paramètres

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

Réponse

Renvoie : ResetUserNotificationsResponse

Exemple

Exemple de reset_user_notification_count

Copy

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

reset_user_notifications

Paramètres

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

update_user_notification_comment_subscription_status

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

Paramètres

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

Copy

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

update_user_notification_page_subscription_status

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

Paramètres

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

update_user_notification_status

Paramètres

Name	Type	Location	Required
tenantId	string	query	Oui
notificationId	string	path	Oui
newStatus	string	path	Oui
sso	string	query	Non

Réponse

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' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

get_user_presence_statuses

Paramètres

Nom	Type	Emplacement	Requis
tenantId	string	requête	Oui
urlIdWS	string	requête	Oui
userIds	string	requête	Oui

Réponse

Retourne : GetUserPresenceStatusesResponse

Exemple

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

search_users

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

get_user

Paramètres

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

Réponse

Renvoie : GetUserResponse

Exemple

Exemple de get_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 | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

create_vote

Paramètres

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

Réponse

Renvoie: VoteResponse

Exemple

Exemple de 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' (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 | 
comment_id = 'comment_id_example' # Chaîne | 
direction = 'up' # Chaîne | 
opts = {
  user_id: 'user_id_example', # Chaîne | 
  anon_user_id: 'anon_user_id_example' # Chaîne | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

delete_vote

Paramètres

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

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple delete_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' (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

get_votes

Paramètres

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

Réponse

Renvoie : GetVotesResponse

Exemple

Exemple de get_votes

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 | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

get_votes_for_user

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'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 | 
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 :

Contributions

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

Langue 🇨🇦 Français (Canada)

Premiers pas

Documentation

Utilisation

Agrégation

Journaux d'audit

Authentification

Blocage depuis un commentaire

Vérifier les commentaires bloqués

Commentaires

Commentaires pour l'utilisateur

Configurations de domaine

Modèles de courriel

Journal d'événements

Publications

Signaler un commentaire

Gifs

Hashtags

Modération

Modérateurs

Nombre de notifications

Notifications

Réactions de page

Pages

Événements de webhook en attente

Configurations de questions

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 des badges utilisateur

Badges utilisateur

Notifications utilisateur

Statuts de présence des utilisateurs

Recherche d'utilisateurs

Utilisateurs

Votes

SDK Ruby de FastComments

Dépôt

Installation

Library Contents

Public vs Secured APIs

Démarrage rapide

Utilisation des API authentifiées (DefaultApi)

Utilisation des API publiques (PublicApi)

Utilisation des API de modération (ModerationApi)

Problèmes courants

Remarques

Identifiants de diffusion

SSO (Authentification unique)

Utilisation SSO

SSO simple

SSO sécurisé

aggregate

Paramètres

Réponse

Exemple

get_audit_logs

Paramètres

Réponse

Exemple

logout_public

Réponse

Exemple

block_from_comment_public

Paramètres

Réponse

Exemple

un_block_comment_public

Paramètres

Réponse

Exemple

checked_comments_for_blocked