
Langue 🇫🇷 Français (France)
Prise en main
Documentation
Agrégation
Journaux d'audit
Blocage depuis un commentaire
Vérifier les commentaires bloqués
Commentaires
Configurations de domaine
Modèles d'e-mail
Journal des événements
Publications
Signalement de commentaire
Hashtags
Modérateurs
Nombre de notifications
Notifications
Pages
Événements 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
Téléverser une image
Progression du badge utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence utilisateur
Recherche d'utilisateurs
Utilisateurs
Votes
FastComments Python SDK
Ceci est le SDK Python officiel pour FastComments.
SDK Python officiel pour l'API FastComments
Repository
Installation 
PyPI
pip install fastcomments
Contenu de la bibliothèque
Cette bibliothèque contient deux modules : le client API généré et la bibliothèque Python principale qui contient des utilitaires écrits à la main pour faciliter l'utilisation de l'API, y compris le support SSO.
APIs publiques vs sécurisées
Pour le client API, il existe deux classes, DefaultApi et PublicApi. La DefaultApi contient des méthodes qui nécessitent votre clé API, et PublicApi contient des appels d'API qui peuvent être effectués directement depuis un navigateur, un appareil mobile, etc., sans authentification.
Démarrage rapide 
Utiliser les API authentifiées (DefaultApi)
Important : Vous devez définir votre clé API dans la Configuration avant d'effectuer des requêtes authentifiées. Sinon, les requêtes échoueront avec une erreur 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Créez et configurez le client API
config = Configuration()
config.host = "https://fastcomments.com/api"
# REQUIS : Définissez votre clé API (récupérez-la depuis votre tableau de bord FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Créez l'instance API avec le client configuré
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Vous pouvez maintenant effectuer des appels API authentifiés
try:
# Exemple : Ajouter un utilisateur SSO
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Erreurs courantes :
# - 401 : la clé API est manquante ou invalide
# - 400 : la validation de la requête a échoué
Utiliser les API publiques (PublicApi)
Les endpoints publics ne nécessitent pas d'authentification :
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Utiliser SSO (Single Sign-On)
Le SDK inclut des utilitaires pour générer des tokens SSO sécurisés :
from sso import FastCommentsSSO, SecureSSOUserData
# Créez les données utilisateur
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Créez l'instance SSO avec votre secret API
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Générez le token SSO
sso_token = sso.create_token()
# Utilisez ce token dans votre frontend ou transmettez-le aux appels API
print(f"SSO Token: {sso_token}")
Pour un SSO simple (moins sécurisé, pour les tests) :
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Problèmes courants
- 401 "missing-api-key" error : Assurez-vous de définir
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}avant de créer l'instance DefaultApi. - Mauvaise classe API : Utilisez
DefaultApipour les requêtes authentifiées côté serveur,PublicApipour les requêtes côté client/publiques. - Erreurs d'importation : Assurez-vous d'importer depuis le module correct :
- Client API :
from client import ... - Utilitaires SSO :
from sso import ...
- Client API :
Remarques 
Identifiants de diffusion
Vous verrez que vous devez transmettre un broadcast_id dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permettra d'ignorer l'événement si vous prévoyez d'appliquer de manière optimiste des modifications côté client (ce que vous voudrez probablement faire car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.
Prérequis 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
aggregate 
Agrège des documents en les groupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Réponse
Retourne : AggregationResponse
Exemple

get_audit_logs 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Retourne: GetAuditLogs200Response
Exemple

block_from_comment_public 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : BlockFromCommentPublic200Response
Exemple

un_block_comment_public 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

checked_comments_for_blocked 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentIds | string | query | Oui | Une liste d'identifiants de commentaires séparés par des virgules. |
| sso | string | query | Non |
Réponse
Renvoie : CheckedCommentsForBlocked200Response
Exemple

block_user_from_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne : BlockFromCommentPublic200Response
Exemple

create_comment_public 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : CreateCommentPublic200Response
Exemple

delete_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie : DeleteComment200Response
Exemple

delete_comment_public 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: DeleteCommentPublic200Response
Exemple

delete_comment_vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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
Retourne: DeleteCommentVote200Response
Exemple

flag_comment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : FlagComment200Response
Exemple

get_comment 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetComment200Response
Exemple

get_comment_text 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetCommentText200Response
Exemple

get_comment_vote_user_names 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie : GetCommentVoteUserNames200Response
Exemple

get_comments 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Réponse
Retourne: GetComments200Response
Exemple

get_comments_public 
requis tenantId urlId
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| 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 : GetCommentsPublic200Response
Exemple

lock_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: LockComment200Response
Exemple

pin_comment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne: PinComment200Response
Exemple

save_comment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Réponse
Retourne: SaveComment200Response
Exemple

save_comments_bulk 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Renvoie : SaveComment200Response
Exemple

set_comment_text 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : SetCommentText200Response
Exemple

un_block_user_from_comment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

un_flag_comment 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne: FlagComment200Response
Exemple

un_lock_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: LockComment200Response
Exemple

un_pin_comment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne: PinComment200Response
Exemple

update_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| doSpamCheck | boolean | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

vote_comment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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 : VoteComment200Response
Exemple

add_domain_config 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: AddDomainConfig200Response
Exemple

delete_domain_config 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : DeleteDomainConfig200Response
Exemple

get_domain_config 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

get_domain_configs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : GetDomainConfigs200Response
Exemple

patch_domain_config 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

put_domain_config 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Retourne: GetDomainConfig200Response
Exemple

create_email_template 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateEmailTemplate200Response
Exemple

delete_email_template 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

delete_email_template_render_error 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| errorId | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

get_email_template 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetEmailTemplate200Response
Exemple

get_email_template_definitions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie: GetEmailTemplateDefinitions200Response
Exemple

get_email_template_render_errors 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplateRenderErrors200Response
Exemple

get_email_templates 
Paramètres
| Name | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetEmailTemplates200Response
Exemple

render_email_template 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Retourne: RenderEmailTemplate200Response
Exemple

update_email_template 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

get_event_log 
req tenantId urlId userIdWS
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Oui |
Réponse
Renvoie : GetEventLog200Response
Exemple

get_global_event_log 
req tenantId urlId userIdWS
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Oui |
Réponse
Renvoie: GetEventLog200Response
Exemple

create_feed_post 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| broadcastId | string | query | Non | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| skipDupCheck | boolean | query | Non |
Réponse
Retourne: CreateFeedPost200Response
Exemple

create_feed_post_public 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| broadcastId | string | requête | Non | |
| sso | string | requête | Non |
Réponse
Renvoie : CreateFeedPostPublic200Response
Exemple

delete_feed_post_public 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : DeleteFeedPostPublic200Response
Exemple

get_feed_posts 
req tenantId afterId
Parameters
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non |
Réponse
Retourne: GetFeedPosts200Response
Exemple

get_feed_posts_public 
req tenantId afterId
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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
Retourne: GetFeedPostsPublic200Response
Exemple

get_feed_posts_stats 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetFeedPostsStats200Response
Exemple

get_user_reacts_public 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserReactsPublic200Response
Exemple

react_feed_post_public 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| isUndo | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Response
Renvoie: ReactFeedPostPublic200Response
Exemple

update_feed_post 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

update_feed_post_public 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : CreateFeedPostPublic200Response
Exemple

flag_comment_public 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| isFlagged | boolean | query | Oui | |
| sso | string | query | Non |
Response
Renvoie: FlagCommentPublic200Response
Exemple

add_hash_tag 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Renvoie: AddHashTag200Response
Exemple

add_hash_tags_bulk 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Retourne: AddHashTagsBulk200Response
Exemple

delete_hash_tag 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Oui | |
| tenantId | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

get_hash_tags 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Renvoie : GetHashTags200Response
Exemple

patch_hash_tag 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | chemin | Oui | |
| tenantId | string | requête | Non |
Réponse
Renvoie: PatchHashTag200Response
Exemple

create_moderator 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: CreateModerator200Response
Exemple

delete_moderator 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sendEmail | string | query | Non |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

get_moderator 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetModerator200Response
Exemple

get_moderators 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetModerators200Response
Exemple

send_invite 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

update_moderator 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

delete_notification_count 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

get_cached_notification_count 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetCachedNotificationCount200Response
Exemple

get_notification_count 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| 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: GetNotificationCount200Response
Exemple

get_notifications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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 : GetNotifications200Response
Exemple

update_notification 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

add_page 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : AddPageAPIResponse
Exemple

delete_page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : DeletePageAPIResponse
Exemple

get_page_by_urlid 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie : GetPageByURLIdAPIResponse
Exemple

get_pages 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: GetPagesAPIResponse
Exemple

patch_page 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: PatchPageAPIResponse
Exemple

delete_pending_webhook_event 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

get_pending_webhook_event_count 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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: GetPendingWebhookEventCount200Response
Exemple

get_pending_webhook_events 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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: GetPendingWebhookEvents200Response
Exemple

create_question_config 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateQuestionConfig200Response
Exemple

delete_question_config 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

get_question_config 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetQuestionConfig200Response
Exemple

get_question_configs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Réponse
Renvoie : GetQuestionConfigs200Response
Exemple

update_question_config 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

create_question_result 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateQuestionResult200Response
Exemple

delete_question_result 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

get_question_result 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne: GetQuestionResult200Response
Exemple

get_question_results 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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
Renvoie: GetQuestionResults200Response
Exemple

update_question_result 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

aggregate_question_results 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| 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 : AggregateQuestionResults200Response
Exemple

bulk_aggregate_question_results 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Retourne: BulkAggregateQuestionResults200Response
Exemple

combine_comments_with_question_results 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| 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
Renvoie : CombineCommentsWithQuestionResults200Response
Exemple

add_sso_user 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: AddSSOUserAPIResponse
Exemple

delete_sso_user 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | boolean | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie : DeleteSSOUserAPIResponse
Exemple

get_sso_user_by_email 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Renvoie : GetSSOUserByEmailAPIResponse
Exemple

get_sso_user_by_id 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetSSOUserByIdAPIResponse
Exemple

get_sso_users 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Réponse
Renvoie : GetSSOUsers200Response
Exemple

patch_sso_user 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Retourne: PatchSSOUserAPIResponse
Exemple

put_sso_user 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PutSSOUserAPIResponse
Exemple

create_subscription 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne: CreateSubscriptionAPIResponse
Exemple

delete_subscription 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : DeleteSubscriptionAPIResponse
Exemple

get_subscriptions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non |
Réponse
Retourne : GetSubscriptionsAPIResponse
Exemple

update_subscription 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Réponse
Retourne: UpdateSubscriptionAPIResponse
Exemple

get_tenant_daily_usages 
Paramètres
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| yearNumber | number | query | Non | |
| monthNumber | number | query | Non | |
| dayNumber | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantDailyUsages200Response
Exemple

create_tenant_package 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateTenantPackage200Response
Exemple

delete_tenant_package 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

get_tenant_package 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetTenantPackage200Response
Exemple

get_tenant_packages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetTenantPackages200Response
Exemple

replace_tenant_package 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

update_tenant_package 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

create_tenant_user 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateTenantUser200Response
Exemple

delete_tenant_user 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | string | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

get_tenant_user 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetTenantUser200Response
Exemple

get_tenant_users 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantUsers200Response
Exemple

replace_tenant_user 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

send_login_link 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| redirectURL | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

update_tenant_user 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

create_tenant 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenant200Response
Exemple

delete_tenant 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sure | string | query | Non |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

get_tenant 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetTenant200Response
Exemple

get_tenants 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| meta | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenants200Response
Exemple

update_tenant 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

change_ticket_state 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: ChangeTicketState200Response
Exemple

create_ticket 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
Réponse
Renvoie: CreateTicket200Response
Exemple

get_ticket 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne : GetTicket200Response
Exemple

get_tickets 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Réponse
Retourne: GetTickets200Response
Exemple

upload_image 
Téléverser et redimensionner une image
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires) |
| urlId | string | query | No | ID de la page depuis laquelle le téléversement est effectué, pour configurer |
Réponse
Renvoie : UploadImageResponse
Exemple

get_user_badge_progress_by_id 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserBadgeProgressById200Response
Exemple

get_user_badge_progress_by_user_id 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Réponse
Renvoie: GetUserBadgeProgressById200Response
Exemple

get_user_badge_progress_list 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie: GetUserBadgeProgressList200Response
Exemple

create_user_badge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateUserBadge200Response
Exemple

delete_user_badge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : UpdateUserBadge200Response
Exemple

get_user_badge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : GetUserBadge200Response
Exemple

get_user_badges 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| badgeId | string | query | Non | |
| type | number | query | Non | |
| displayedOnComments | boolean | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetUserBadges200Response
Exemple

update_user_badge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: UpdateUserBadge200Response
Exemple

get_user_notification_count 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotificationCount200Response
Exemple

get_user_notifications 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie: GetUserNotifications200Response
Exemple

reset_user_notification_count 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : ResetUserNotifications200Response
Exemple

reset_user_notifications 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Retourne : ResetUserNotifications200Response
Exemple

update_user_notification_comment_subscription_status 
Activer ou désactiver les notifications pour un commentaire spécifique.
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie : UpdateUserNotificationStatus200Response
Exemple

update_user_notification_page_subscription_status 
Activer ou désactiver les notifications pour une page. Lorsque les utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racine, et aussi
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| 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 : UpdateUserNotificationStatus200Response
Exemple

update_user_notification_status 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| newStatus | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UpdateUserNotificationStatus200Response
Exemple

get_user_presence_statuses 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlIdWS | string | query | Oui | |
| userIds | string | query | Oui |
Retourne
Retourne: GetUserPresenceStatuses200Response
Exemple

search_users 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 : SearchUsers200Response
Exemple

get_user 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetUser200Response
Exemple

create_vote 
Paramètres
| Name | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Oui | |
| direction | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : VoteComment200Response
Exemple

delete_vote 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Réponse
Renvoie : DeleteCommentVote200Response
Exemple

get_votes 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Réponse
Renvoie : GetVotes200Response
Exemple

get_votes_for_user 
Paramètres
| Name | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : GetVotesForUser200Response
Exemple

Besoin d'aide ?
Si vous rencontrez des problèmes ou avez des questions concernant le SDK Python, veuillez :
Contribuer
Les contributions sont les bienvenues ! Veuillez consulter le dépôt GitHub pour les consignes de contribution.