FastComments.com

SDK PHP de FastComments

Ceci est le SDK PHP officiel pour FastComments.

SDK PHP officiel pour l'API de FastComments

Dépôt

Voir sur GitHub


Installation et utilisation Internal Link


Exigences

PHP 7.4 et versions ultérieures. Devrait également fonctionner avec PHP 8.0.

Composer

Pour installer les bindings via Composer, ajoutez ce qui suit à composer.json :

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/fastcomments/fastcomments-php.git"
    }
  ],
  "require": {
    "fastcomments/fastcomments-php": "*@dev"
  }
}

Puis exécutez composer install

Installation manuelle

Téléchargez les fichiers et incluez autoload.php :

<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');

Premiers pas Internal Link

Veuillez suivre la procédure d'installation, puis exécuter ce qui suit :

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configurer l'authentification par clé API : api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
    // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // chaîne
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams

try {
    $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}

Clients API Internal Link

Le SDK expose trois classes client d’API :

  • DefaultApi – Méthodes authentifiées par clé API pour une utilisation côté serveur. Configurez une clé API comme indiqué dans Getting Started.
  • PublicApi – Méthodes publiques qui ne nécessitent pas de clé API, sécurisées pour être appelées depuis les navigateurs et les applications mobiles.
  • ModerationApi – Une suite étendue d’API de modération en temps réel et rapides. Chaque méthode ModerationApi accepte un paramètre $sso et peut s’authentifier via SSO ou un cookie de session FastComments.com.

Utilisation de PublicApi

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Les méthodes publiques ne nécessitent pas de clé API.
$apiInstance = new FastComments\Client\Api\PublicApi(
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // chaîne
$url_id = 'url_id_example'; // chaîne

try {
    $result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}

Utilisation de ModerationApi

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new FastComments\Client\Api\ModerationApi(
    new GuzzleHttp\Client()
);
$sso = 'sso_example'; // chaîne - charge utile SSO authentifiant le modérateur

try {
    $result = $apiInstance->getCount([
        'sso' => $sso,
    ]);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}

Modèles Internal Link

Autorisation Internal Link


Schémas d'authentification définis pour l'API:

api_key

  • Type: clé API
  • Nom du paramètre de la clé API: x-api-key
  • Emplacement: en-tête HTTP

Auteur Internal Link

support@fastcomments.com

aggregate Internal Link

Agrège les documents en les regroupant (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

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
parentTenantIdstringqueryNon
includeStatsbooleanqueryNon

Réponse

Renvoie : AggregateResponse

Exemple

Exemple d'agrégation
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
21$options = [
22 'parent_tenant_id' => 'parent_tenant_id_example', // chaîne
23 'include_stats' => True, // booléen
24];
25
26
27try {
28 $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
32}
33

getAuditLogs Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
limitnumberqueryNon
skipnumberqueryNon
orderstringqueryNon
afternumberqueryNon
beforenumberqueryNon

Réponse

Retourne : GetAuditLogsResponse

Exemple

Exemple getAuditLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommenter ci-dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'limit' => 3.4, // float
22 'skip' => 3.4, // float
23 'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
24 'after' => 3.4, // float
25 'before' => 3.4, // float
26];
27
28
29try {
30 $result = $apiInstance->getAuditLogs($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
34}
35

logoutPublic Internal Link

Response

Renvoie: APIEmptyResponse

Example

Exemple logoutPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13
14
15try {
16 $result = $apiInstance->logoutPublic();
17 print_r($result);
18} catch (Exception $e) {
19 echo 'Exception when calling PublicApi->logoutPublic: ', $e->getMessage(), PHP_EOL;
20}
21

blockFromCommentPublic Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
commentIdstringpathOui
ssostringqueryNon

Réponse

Renvoie : BlockSuccess

Exemple

blockFromCommentPublic Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

unBlockCommentPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
ssostringqueryNon

Réponse

Retourne : UnblockSuccess

Exemple

Exemple de unBlockCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // chaîne
17
18
19try {
20 $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sss);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

checkedCommentsForBlocked Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdsstringqueryYesUne liste séparée par des virgules d’identifiants de commentaires.
ssostringqueryNo

Réponse

Renvoie : CheckBlockedCommentsResponse

Exemple

Exemple checkedCommentsForBlocked
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_ids = 'comment_ids_example'; // string | Une liste séparée par des virgules d’identifiants de commentaires.
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
23}
24

blockUserFromComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Réponse

Retourne : BlockSuccess

Exemple

Exemple de blockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34

createCommentPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

Réponse

Retour : SaveCommentsResponseWithPresence

Exemple

Exemple createCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
17$options = [
18 'session_id' => 'session_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
28}
29

deleteComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
contextUserIdstringqueryNon
isLivebooleanqueryNon

Réponse

Renvoie : DeleteCommentResult

Exemple

Exemple deleteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurez l'autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // C'est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$options = [
21 'context_user_id' => 'context_user_id_example', // string
22 'is_live' => True, // bool
23];
24
25
26try {
27 $result = $apiInstance->deleteComment($tenant_id, $id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
31}
32

deleteCommentPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Réponse

Renvoie : PublicAPIDeleteCommentResponse

Exemple

deleteCommentPublic Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$options = [
17 'edit_key' => 'edit_key_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
27}
28

deleteCommentVote Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
voteIdstringpathOui
urlIdstringqueryOui
broadcastIdstringqueryOui
editKeystringqueryNon
ssostringqueryNon

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple de suppression de vote de commentaire
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$vote_id = 'vote_id_example'; // chaîne
16$url_id = 'url_id_example'; // chaîne
17$broadcast_id = 'broadcast_id_example'; // chaîne
18$options = [
19 'edit_key' => 'edit_key_example', // chaîne
20 'sso' => 'sso_example', // chaîne
21];
22
23
24try {
25 $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
29}
30

flagComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
userIdstringqueryNon
anonUserIdstringqueryNon

Réponse

Renvoie : FlagCommentResponse

Exemple

flagComment Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé d'API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->flagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
32}
33

getComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : APIGetCommentResponse

Exemple

Exemple getComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getComment($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
28}
29

getComments Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

Réponse

Renvoie : APIGetCommentsResponse

Exemple

Exemple getComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$options = [
20 'page' => 56, // entier
21 'limit' => 56, // entier
22 'skip' => 56, // entier
23 'as_tree' => True, // booléen
24 'skip_children' => 56, // entier
25 'limit_children' => 56, // entier
26 'max_tree_depth' => 56, // entier
27 'url_id' => 'url_id_example', // chaîne
28 'user_id' => 'user_id_example', // chaîne
29 'anon_user_id' => 'anon_user_id_example', // chaîne
30 'context_user_id' => 'context_user_id_example', // chaîne
31 'hash_tag' => 'hash_tag_example', // chaîne
32 'parent_id' => 'parent_id_example', // chaîne
33 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
34 'from_date' => 56, // entier
35 'to_date' => 56, // entier
36];
37
38
39try {
40 $result = $apiInstance->getComments($tenant_id, $options);
41 print_r($result);
42} catch (Exception $e) {
43 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
44}
45

getCommentsPublic Internal Link

req tenantId urlId

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
urlIdstringqueryYes
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

Réponse

Retourne : GetCommentsResponseWithPresencePublicComment

Exemple

Exemple getCommentsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15$options = [
16 'page' => 56, // entier
17 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
18 'sso' => 'sso_example', // chaîne
19 'skip' => 56, // entier
20 'skip_children' => 56, // entier
21 'limit' => 56, // entier
22 'limit_children' => 56, // entier
23 'count_children' => True, // booléen
24 'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // chaîne
25 'include_config' => True, // booléen
26 'count_all' => True, // booléen
27 'includei10n' => True, // booléen
28 'locale' => 'locale_example', // chaîne
29 'modules' => 'modules_example', // chaîne
30 'is_crawler' => True, // booléen
31 'include_notification_count' => True, // booléen
32 'as_tree' => True, // booléen
33 'max_tree_depth' => 56, // entier
34 'use_full_translation_ids' => True, // booléen
35 'parent_id' => 'parent_id_example', // chaîne
36 'search_text' => 'search_text_example', // chaîne
37 'hash_tags' => array('hash_tags_example'), // string[]
38 'user_id' => 'user_id_example', // chaîne
39 'custom_config_str' => 'custom_config_str_example', // chaîne
40 'after_comment_id' => 'after_comment_id_example', // chaîne
41 'before_comment_id' => 'before_comment_id_example', // chaîne
42];
43
44
45try {
46 $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $options);
47 print_r($result);
48} catch (Exception $e) {
49 echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
50}
51

getCommentText Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
editKeystringqueryNon
ssostringqueryNon

Réponse

Renvoie : PublicAPIGetCommentTextResponse

Exemple

getCommentText Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'edit_key' => 'edit_key_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getCommentText($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
26}
27

getCommentVoteUserNames Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
dirintegerqueryOui
ssostringqueryNon

Réponse

Renvoie : GetCommentVoteUserNamesSuccessResponse

Exemple

Exemple getCommentVoteUserNames
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$dir = 56; // int
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
24}
25

lockComment Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Réponse

Returns: APIEmptyResponse

Exemple

Exemple de lockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
24}
25

pinComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
broadcastIdstringqueryOui
ssostringqueryNon

Réponse

Retourne : ChangeCommentPinStatusResponse

Exemple

Exemple de pinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // C’est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
24}
25

saveComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Réponse

Renvoie : APISaveCommentResponse

Exemple

Exemple saveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// // Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
21$options = [
22 'is_live' => True, // booléen
23 'do_spam_check' => True, // booléen
24 'send_emails' => True, // booléen
25 'populate_notifications' => True, // booléen
26];
27
28
29try {
30 $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
34}
35

saveCommentsBulk Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Réponse

Retourne : SaveCommentsBulkResponse

Exemple

saveCommentsBulk Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
21$options = [
22 'is_live' => True, // booléen
23 'do_spam_check' => True, // booléen
24 'send_emails' => True, // booléen
25 'populate_notifications' => True, // booléen
26];
27
28
29try {
30 $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
34}
35

setCommentText Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
broadcastIdstringqueryOui
editKeystringqueryNon
ssostringqueryNon

Réponse

Retourne : PublicAPISetCommentTextResponse

Exemple

Exemple setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
17$options = [
18 'edit_key' => 'edit_key_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
28}
29

unBlockUserFromComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Réponse

Renvoie : UnblockSuccess

Exemple

Exemple unBlockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si besoin
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception lors de l\'appel de DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34

unFlagComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Réponse

Renvoie : FlagCommentResponse

Exemple

Exemple de unFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'user_id' => 'user_id_example', // string
23 'anon_user_id' => 'anon_user_id_example', // string
24];
25
26
27try {
28 $result = $apiInstance->unFlagComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
32}
33

unLockComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
broadcastIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de déverrouillage de commentaire
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$broadcast_id = 'broadcast_id_example'; // chaîne
16$sso = 'sso_example'; // chaîne
17
18
19try {
20 $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
24}
25

unPinComment Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringpathOui
commentIdstringpathOui
broadcastIdstringqueryOui
ssostringqueryNon

Réponse

Returns: ChangeCommentPinStatusResponse

Exemple

unPinComment Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$broadcast_id = 'broadcast_id_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
24}
25

updateComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de updateComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
21$options = [
22 'context_user_id' => 'context_user_id_example', // string
23 'do_spam_check' => True, // bool
24 'is_live' => True, // bool
25];
26
27
28try {
29 $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
33}
34

voteComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
commentIdstringpathOui
urlIdstringqueryOui
broadcastIdstringqueryOui
sessionIdstringqueryNon
ssostringqueryNon

Réponse

Retourne : VoteResponse

Exemple

Exemple voteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$url_id = 'url_id_example'; // chaîne
16$broadcast_id = 'broadcast_id_example'; // chaîne
17$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
18$options = [
19 'session_id' => 'session_id_example', // chaîne
20 'sso' => 'sso_example', // chaîne
21];
22
23
24try {
25 $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
29}
30

getCommentsForUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Réponse

Returns: GetCommentsForUserResponse

Exemple

Exemple de getCommentsForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$options = [
14 'user_id' => 'user_id_example', // chaîne
15 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
16 'replies_to_user_id' => 'replies_to_user_id_example', // chaîne
17 'page' => 3.4, // nombre à virgule flottante
18 'includei10n' => True, // booléen
19 'locale' => 'locale_example', // chaîne
20 'is_crawler' => True, // booléen
21];
22
23
24try {
25 $result = $apiInstance->getCommentsForUser($options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getCommentsForUser: ', $e->getMessage(), PHP_EOL;
29}
30

addDomainConfig Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: AddDomainConfigResponse

Example

Exemple addDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
12 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
19
20
21try {
22 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteDomainConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
domainstringpathYes

Réponse

Renvoie : DeleteDomainConfigResponse

Exemple

Exemple deleteDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$domain = 'domain_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29

getDomainConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
domainstringpathOui

Réponse

Renvoie : GetDomainConfigResponse

Exemple

Exemple getDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$domain = 'domain_example'; // string
20
21
22try {
23 $result = $apiInstance->getDomainConfig($tenant_id, $domain);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
27}
28

getDomainConfigs Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : GetDomainConfigsResponse

Exemple

Exemple getDomainConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20
21
22try {
23 $result = $apiInstance->getDomainConfigs($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
27}
28

patchDomainConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
domainToUpdatestringpathOui

Réponse

Renvoie : PatchDomainConfigResponse

Exemple

Exemple de patchDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$domain_to_update = 'domain_to_update_example'; // string
20$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
21
22
23try {
24 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29

putDomainConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
domainToUpdatestringpathOui

Réponse

Retourne : PutDomainConfigResponse

Exemple

putDomainConfig Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurez l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$domain_to_update = 'domain_to_update_example'; // string
21$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
22
23
24try {
25 $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30

createEmailTemplate Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Renvoie : CreateEmailTemplateResponse

Exemple

createEmailTemplate Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
21
22
23try {
24 $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29

deleteEmailTemplate Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Returns: APIEmptyResponse

Exemple

Exemple de deleteEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29

deleteEmailTemplateRenderError Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
errorIdstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de deleteEmailTemplateRenderError
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
7
8
9$apiInstance = new FastComments\Client\Api\DefaultApi(
10 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
11 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
12 new GuzzleHttp\Client(),
13 $config
14);
15
16$tenant_id = 'tenant_id_example'; // chaîne
17$id = 'id_example'; // chaîne
18$error_id = 'error_id_example'; // chaîne
19
20
21try {
22 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
26}
27

getEmailTemplate Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : GetEmailTemplateResponse

Exemple

Exemple getEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29

getEmailTemplateDefinitions Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Renvoie : GetEmailTemplateDefinitionsResponse

Exemple

Exemple getEmailTemplateDefinitions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20
21
22try {
23 $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
27}
28

getEmailTemplateRenderErrors Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
skipnumberqueryNon

Réponse

Renvoie : GetEmailTemplateRenderErrorsResponse

Exemple

getEmailTemplateRenderErrors Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$skip = 3.4; // flottant
22
23
24try {
25 $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
29}
30

getEmailTemplates Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
skipnumberqueryNon

Réponse

Retourne : GetEmailTemplatesResponse

Exemple

Exemple getEmailTemplates
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$skip = 3.4; // flottant
21
22
23try {
24 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
28}
29

renderEmailTemplate Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
localestringqueryNon

Réponse

Retourne : RenderEmailTemplateResponse

Exemple

renderEmailTemplate Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
21$locale = 'locale_example'; // chaîne
22
23
24try {
25 $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
29}
30

updateEmailTemplate Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de updateEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
22
23
24try {
25 $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
29}
30

getEventLog Internal Link

req tenantId urlId userIdWS

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringpathOui
urlIdstringqueryOui
userIdWSstringqueryOui
startTimeintegerqueryOui
endTimeintegerqueryNon

Réponse

Renvoie : GetEventLogResponse

Exemple

Exemple getEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$user_id_ws = 'user_id_ws_example'; // string
16$start_time = 56; // int
17$end_time = 56; // int
18
19
20try {
21 $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
25}
26

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
urlIdstringqueryOui
userIdWSstringqueryOui
startTimeintegerqueryOui
endTimeintegerqueryNon

Réponse

Renvoie : GetEventLogResponse

Exemple

Exemple getGlobalEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$user_id_ws = 'user_id_ws_example'; // string
16$start_time = 56; // int
17$end_time = 56; // int
18
19
20try {
21 $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
25}
26

createFeedPost Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Réponse

Renvoie : CreateFeedPostResponse

Exemple

createFeedPost Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
21$options = [
22 'broadcast_id' => 'broadcast_id_example', // chaîne
23 'is_live' => True, // booléen
24 'do_spam_check' => True, // booléen
25 'skip_dup_check' => True, // booléen
26];
27
28
29try {
30 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
34}
35

createFeedPostPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Retourne : CreateFeedPostResponse

Exemple

Exemple createFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception lors de l\'appel de PublicApi->createFeedPostPublic : ', $e->getMessage(), PHP_EOL;
26}
27

deleteFeedPostPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
postIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : DeleteFeedPostPublicResponse

Exemple

deleteFeedPostPublic Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$post_id = 'post_id_example'; // chaîne
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // chaîne
17 'sso' => 'sso_example', // chaîne
18];
19
20
21try {
22 $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27

getFeedPosts Internal Link

requête tenantId afterId

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
afterIdstringqueryNon
limitintegerqueryNon
tagsarrayqueryNon

Réponse

Retourne : GetFeedPostsResponse

Exemple

Exemple getFeedPosts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$options = [
21 'after_id' => 'after_id_example', // chaîne
22 'limit' => 56, // int
23 'tags' => array('tags_example'), // chaîne[]
24];
25
26
27try {
28 $result = $apiInstance->getFeedPosts($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
32}
33

getFeedPostsPublic Internal Link

req tenantId afterId

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
afterIdstringqueryNon
limitintegerqueryNon
tagsarrayqueryNon
ssostringqueryNon
isCrawlerbooleanqueryNon
includeUserInfobooleanqueryNon

Réponse

Renvoie : PublicFeedPostsResponse

Exemple

Exemple getFeedPostsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'after_id' => 'after_id_example', // string
16 'limit' => 56, // int
17 'tags' => array('tags_example'), // string[]
18 'sso' => 'sso_example', // string
19 'is_crawler' => True, // bool
20 'include_user_info' => True, // bool
21];
22
23
24try {
25 $result = $apiInstance->getFeedPostsPublic($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
29}
30

getFeedPostsStats Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringpathOui
postIdsarrayqueryOui
ssostringqueryNon

Réponse

Retourne : FeedPostsStatsResponse

Exemple

Exemple getFeedPostsStats
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_ids = array('post_ids_example'); // string[]
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
23}
24

getUserReactsPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
postIdsarrayqueryNo
ssostringqueryNo

Réponse

Renvoie : UserReactsResponse

Exemple

Exemple getUserReactsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'post_ids' => array('post_ids_example'), // chaîne[]
16 'sso' => 'sso_example', // chaîne
17];
18
19
20try {
21 $result = $apiInstance->getUserReactsPublic($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
25}
26

reactFeedPostPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
postIdstringpathOui
isUndobooleanqueryNon
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Retourne : ReactFeedPostResponse

Exemple

Exemple reactFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
16$options = [
17 'is_undo' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // chaîne
19 'sso' => 'sso_example', // chaîne
20];
21
22
23try {
24 $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
28}
29

updateFeedPost Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple updateFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
22
23
24try {
25 $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
29}
30

updateFeedPostPublic Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Retourne : CreateFeedPostResponse

Exemple

Exemple updateFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // C’est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$post_id = 'post_id_example'; // chaîne
15$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // chaîne
18 'sso' => 'sso_example', // chaîne
19];
20
21
22try {
23 $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
27}
28

flagCommentPublic Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
isFlaggedbooleanqueryOui
ssostringqueryNon

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple flagCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$is_flagged = True; // bool
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

getGifLarge Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
largeInternalURLSanitizedstringqueryYes

Réponse

Renvoie : GifGetLargeResponse

Exemple

Exemple getGifLarge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // chaîne
15
16
17try {
18 $result = $apiInstance->getGifLarge($tenant_id, $large_internal_url_sanitized);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getGifLarge: ', $e->getMessage(), PHP_EOL;
22}
23

getGifsSearch Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Réponse

Retourne : GetGifsSearchResponse

Exemple

Exemple getGifsSearch
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// Créez une instance de l'API publique.
8// Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9// Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10$apiInstance = new FastComments\Client\Api\PublicApi(
11 new GuzzleHttp\Client()
12);
13
14$tenant_id = 'tenant_id_example'; // string
15$search = 'search_example'; // string
16$options = [
17 'locale' => 'locale_example', // string
18 'rating' => 'rating_example', // string
19 'page' => 3.4, // float
20];
21
22
23try {
24 $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
28}
29

getGifsTrending Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringcheminOui
localestringrequêteNon
ratingstringrequêteNon
pagenumberrequêteNon

Réponse

Retourne : GetGifsTrendingResponse

Exemple

Exemple getGifsTrending
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'locale' => 'locale_example', // string
16 'rating' => 'rating_example', // string
17 'page' => 3.4, // float
18];
19
20
21try {
22 $result = $apiInstance->getGifsTrending($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getGifsTrending: ', $e->getMessage(), PHP_EOL;
26}
27

addHashTag Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes

Réponse

Renvoie : CreateHashTagResponse

Exemple

addHashTag Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
21
22
23try {
24 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
28}
29

addHashTagsBulk Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Renvoie : BulkCreateHashTagsResponse

Exemple

Exemple addHashTagsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21
22try {
23 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
27}
28

deleteHashTag Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
tagstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple deleteHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$delete_hash_tag_request_body = new \FastComments\Client\Model\DeleteHashTagRequestBody(); // \FastComments\Client\Model\DeleteHashTagRequestBody
22
23
24try {
25 $result = $apiInstance->deleteHashTag($tenant_id, $tag, $delete_hash_tag_request_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
29}
30

getHashTags Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
pagenumberqueryNon

Réponse

Renvoie : GetHashTagsResponse

Exemple

Exemple getHashTags
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$page = 3.4; // flottant
20
21
22try {
23 $result = $apiInstance->getHashTags($tenant_id, $page);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
27}
28

patchHashTag Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
tagstringpathYes

Réponse

Renvoie : UpdateHashTagResponse

Exemple

Exemple de patchHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$tag = 'tag_example'; // chaîne
20$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
21
22
23try {
24 $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
28}
29

deleteModerationVote Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
voteIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : VoteDeleteResponse

Exemple

Exemple de suppression du vote de modération
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$vote_id = 'vote_id_example'; // string
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->deleteModerationVote($tenant_id, $comment_id, $vote_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
27}
28

getApiComments Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
pagenumberqueryNon
countnumberqueryNon
text-searchstringqueryNon
byIPFromCommentstringqueryNon
filtersstringqueryNon
searchFiltersstringqueryNon
sortsstringqueryNon
demobooleanqueryNon
ssostringqueryNon

Réponse

Retourne : ModerationAPIGetCommentsResponse

Exemple

Exemple getApiComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'page' => 3.4, // flottant
16 'count' => 3.4, // flottant
17 'text_search' => 'text_search_example', // chaîne
18 'by_ip_from_comment' => 'by_ip_from_comment_example', // chaîne
19 'filters' => 'filters_example', // chaîne
20 'search_filters' => 'search_filters_example', // chaîne
21 'sorts' => 'sorts_example', // chaîne
22 'demo' => True, // booléen
23 'sso' => 'sso_example', // chaîne
24];
25
26
27try {
28 $result = $apiInstance->getApiComments($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling ModerationApi->getApiComments: ', $e->getMessage(), PHP_EOL;
32}
33

getApiExportStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

Réponse

Renvoie : ModerationExportStatusResponse

Exemple

Exemple getApiExportStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'batch_job_id' => 'batch_job_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getApiExportStatus($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getApiExportStatus: ', $e->getMessage(), PHP_EOL;
25}
26

getApiIds Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Réponse

Retourne : ModerationAPIGetCommentIdsResponse

Exemple

Exemple getApiIds
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filters' => 'filters_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'after_id' => 'after_id_example', // string
20 'demo' => True, // bool
21 'sso' => 'sso_example', // string
22];
23
24
25try {
26 $result = $apiInstance->getApiIds($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
30}
31

getBanUsersFromComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
ssostringqueryNon

Réponse

Renvoie : GetBannedUsersFromCommentResponse

Exemple

Exemple getBanUsersFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
23}
24

getCommentBanStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
ssostringqueryNon

Réponse

Retourne : GetCommentBanStatusResponse

Exemple

Exemple getCommentBanStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getCommentBanStatus($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getCommentBanStatus: ', $e->getMessage(), PHP_EOL;
23}
24

getCommentChildren Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Réponse

Retourne : ModerationAPIChildCommentsResponse

Exemple

Exemple getCommentChildren
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // C'est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getCommentChildren($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getCommentChildren: ', $e->getMessage(), PHP_EOL;
23}
24

getCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
text-searchstringqueryNon
byIPFromCommentstringqueryNon
filterstringqueryNon
searchFiltersstringqueryNon
demobooleanqueryNon
ssostringqueryNon

Réponse

Renvoie : ModerationAPICountCommentsResponse

Exemple

Exemple getCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'text_search' => 'text_search_example', // chaîne
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // chaîne
17 'filter' => 'filter_example', // chaîne
18 'search_filters' => 'search_filters_example', // chaîne
19 'demo' => True, // booléen
20 'sso' => 'sso_example', // chaîne
21];
22
23
24try {
25 $result = $apiInstance->getCount($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
29}
30

getCounts Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : GetBannedUsersCountResponse

Exemple

Exemple getCounts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getCounts($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getCounts: ', $e->getMessage(), PHP_EOL;
22}
23

getLogs Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
ssostringqueryNon

Réponse

Renvoie : ModerationAPIGetLogsResponse

Exemple

Exemple getLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getLogs($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getLogs: ', $e->getMessage(), PHP_EOL;
23}
24

getManualBadges Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : GetTenantManualBadgesResponse

Exemple

Exemple getManualBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$sso = 'sso_example'; // chaîne
15
16
17try {
18 $result = $apiInstance->getManualBadges($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getManualBadges: ', $e->getMessage(), PHP_EOL;
22}
23

getManualBadgesForUser Internal Link


Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
badgesUserIdstringqueryNon
commentIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : GetUserManualBadgesResponse

Exemple

Exemple getManualBadgesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'badges_user_id' => 'badges_user_id_example', // string
16 'comment_id' => 'comment_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
26}
27

getModerationComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Réponse

Renvoie : ModerationAPICommentResponse

Exemple

Exemple getModerationComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'include_email' => True, // bool
17 'include_ip' => True, // bool
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->getModerationComment($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getModerationComment: ', $e->getMessage(), PHP_EOL;
27}
28

getModerationCommentText Internal Link

Parameters

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Retourne : GetCommentTextResponse

Exemple

getModerationCommentText Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getModerationCommentText($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getModerationCommentText: ', $e->getMessage(), PHP_EOL;
23}
24

getPreBanSummary Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Réponse

Renvoie : PreBanSummary

Exemple

Exemple getPreBanSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$options = [
16 'include_by_user_id_and_email' => True, // booléen
17 'include_by_ip' => True, // booléen
18 'include_by_email_domain' => True, // booléen
19 'sso' => 'sso_example', // chaîne
20];
21
22
23try {
24 $result = $apiInstance->getPreBanSummary($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29

getSearchCommentsSummary Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Réponse

Returns: ModerationCommentSearchResponse

Exemple

Exemple getSearchCommentsSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'filters' => 'filters_example', // string
17 'search_filters' => 'search_filters_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->getSearchCommentsSummary($tenant_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->getSearchCommentsSummary: ', $e->getMessage(), PHP_EOL;
27}
28

getSearchPages Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
valuestringqueryNon
ssostringqueryNon

Réponse

Renvoie : ModerationPageSearchResponse

Exemple

Exemple getSearchPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchPages($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchPages: ', $e->getMessage(), PHP_EOL;
25}
26

getSearchSites Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
valuestringqueryNon
ssostringqueryNon

Réponse

Renvoie : ModerationSiteSearchResponse

Exemple

getSearchSites Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'value' => 'value_example', // chaîne
16 'sso' => 'sso_example', // chaîne
17];
18
19
20try {
21 $result = $apiInstance->getSearchSites($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
25}
26

getSearchSuggest Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
text-searchstringqueryNon
ssostringqueryNon

Réponse

Renvoie : ModerationSuggestResponse

Exemple

Exemple getSearchSuggest
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'text_search' => 'text_search_example', // chaîne
16 'sso' => 'sso_example', // chaîne
17];
18
19
20try {
21 $result = $apiInstance->getSearchSuggest($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchSuggest: ', $e->getMessage(), PHP_EOL;
25}
26

getSearchUsers Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
valuestringqueryNon
ssostringqueryNon

Réponse

Retourne : ModerationUserSearchResponse

Exemple

Exemple getSearchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'value' => 'value_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getSearchUsers($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getSearchUsers: ', $e->getMessage(), PHP_EOL;
25}
26

getTrustFactor Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryNon
ssostringqueryNon

Réponse

Retourne : GetUserTrustFactorResponse

Exemple

Exemple getTrustFactor
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'user_id' => 'user_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getTrustFactor($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception lors de l\'appel de ModerationApi->getTrustFactor : ', $e->getMessage(), PHP_EOL;
25}
26

getUserBanPreference Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringrequêteOui
ssostringrequêteNon

Réponse

Renvoie: APIModerateGetUserBanPreferencesResponse

Exemple

Exemple de getUserBanPreference
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$sso = 'sso_example'; // chaîne
15
16
17try {
18 $result = $apiInstance->getUserBanPreference($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling ModerationApi->getUserBanPreference: ', $e->getMessage(), PHP_EOL;
22}
23

getUserInternalProfile Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringqueryNo
ssostringqueryNo

Réponse

Renvoie : GetUserInternalProfileResponse

Exemple

Exemple getUserInternalProfile
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'comment_id' => 'comment_id_example', // string
16 'sso' => 'sso_example', // string
17];
18
19
20try {
21 $result = $apiInstance->getUserInternalProfile($tenant_id, $options);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling ModerationApi->getUserInternalProfile: ', $e->getMessage(), PHP_EOL;
25}
26

postAdjustCommentVotes Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Renvoie : AdjustVotesResponse

Exemple

postAdjustCommentVotes Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postAdjustCommentVotes: ', $e->getMessage(), PHP_EOL;
27}
28

postApiExport Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
text-searchstringqueryNon
byIPFromCommentstringqueryNon
filtersstringqueryNon
searchFiltersstringqueryNon
sortsstringqueryNon
ssostringqueryNon

Réponse

Renvoie : ModerationExportResponse

Exemple

Exemple postApiExport
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'text_search' => 'text_search_example', // chaîne
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // chaîne
17 'filters' => 'filters_example', // chaîne
18 'search_filters' => 'search_filters_example', // chaîne
19 'sorts' => 'sorts_example', // chaîne
20 'sso' => 'sso_example', // chaîne
21];
22
23
24try {
25 $result = $apiInstance->postApiExport($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->postApiExport: ', $e->getMessage(), PHP_EOL;
29}
30

postBanUserFromComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
banEmailbooleanqueryNon
banEmailDomainbooleanqueryNon
banIPbooleanqueryNon
deleteAllUsersCommentsbooleanqueryNon
bannedUntilstringqueryNon
isShadowBanbooleanqueryNon
updateIdstringqueryNon
banReasonstringqueryNon
ssostringqueryNon

Réponse

Renvoie : BanUserFromCommentResult

Exemple

Exemple postBanUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$options = [
16 'ban_email' => True, // booléen
17 'ban_email_domain' => True, // booléen
18 'ban_ip' => True, // booléen
19 'delete_all_users_comments' => True, // booléen
20 'banned_until' => 'banned_until_example', // chaîne
21 'is_shadow_ban' => True, // booléen
22 'update_id' => 'update_id_example', // chaîne
23 'ban_reason' => 'ban_reason_example', // chaîne
24 'sso' => 'sso_example', // chaîne
25];
26
27
28try {
29 $result = $apiInstance->postBanUserFromComment($tenant_id, $comment_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling ModerationApi->postBanUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34

postBanUserUndo Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
ssostringqueryNo

Réponse

Returns: APIEmptyResponse

Exemple

Exemple postBanUserUndo
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
15$sso = 'sso_example'; // chaîne
16
17
18try {
19 $result = $apiInstance->postBanUserUndo($tenant_id, $ban_user_undo_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postBanUserUndo: ', $e->getMessage(), PHP_EOL;
23}
24

postBulkPreBanSummary Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Réponse

Renvoie : BulkPreBanSummary

Exemple

postBulkPreBanSummary Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
15$options = [
16 'include_by_user_id_and_email' => True, // bool
17 'include_by_ip' => True, // bool
18 'include_by_email_domain' => True, // bool
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29

postCommentsByIds Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : ModerationAPIChildCommentsResponse

Exemple

Exemple postCommentsByIds
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->postCommentsByIds($tenant_id, $comments_by_ids_params, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->postCommentsByIds: ', $e->getMessage(), PHP_EOL;
23}
24

postFlagComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : APIEmptyResponse

Exemple

postFlagComment Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27

postRemoveComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : PostRemoveCommentApiResponse

Exemple

Exemple postRemoveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postRemoveComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRemoveComment: ', $e->getMessage(), PHP_EOL;
26}
27

postRestoreDeletedComment Internal Link


Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Retourne : APIEmptyResponse

Exemple

postRestoreDeletedComment Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postRestoreDeletedComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postRestoreDeletedComment: ', $e->getMessage(), PHP_EOL;
26}
27

postSetCommentApprovalStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Retourne : SetCommentApprovedResponse

Exemple

postSetCommentApprovalStatus Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'approved' => True, // bool
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentApprovalStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentApprovalStatus: ', $e->getMessage(), PHP_EOL;
27}
28

postSetCommentReviewStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
reviewedbooleanqueryNon
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Returns: APIEmptyResponse

Exemple

Exemple postSetCommentReviewStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$options = [
16 'reviewed' => True, // booléen
17 'broadcast_id' => 'broadcast_id_example', // chaîne
18 'sso' => 'sso_example', // chaîne
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentReviewStatus($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentReviewStatus: ', $e->getMessage(), PHP_EOL;
27}
28

postSetCommentSpamStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple postSetCommentSpamStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$comment_id = 'comment_id_example'; // chaîne
15$options = [
16 'spam' => True, // booléen
17 'perm_not_spam' => True, // booléen
18 'broadcast_id' => 'broadcast_id_example', // chaîne
19 'sso' => 'sso_example', // chaîne
20];
21
22
23try {
24 $result = $apiInstance->postSetCommentSpamStatus($tenant_id, $comment_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postSetCommentSpamStatus: ', $e->getMessage(), PHP_EOL;
28}
29

postSetCommentText Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : SetCommentTextResponse

Exemple

Exemple postSetCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postSetCommentText: ', $e->getMessage(), PHP_EOL;
27}
28

postUnFlagComment Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Réponse

Retourne : APIEmptyResponse

Exemple

postUnFlagComment Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->postUnFlagComment($tenant_id, $comment_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->postUnFlagComment: ', $e->getMessage(), PHP_EOL;
26}
27

postVote Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringpathOui
directionstringqueryNon
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Retourne : VoteResponse

Exemple

Exemple postVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'direction' => 'direction_example', // string
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
19];
20
21
22try {
23 $result = $apiInstance->postVote($tenant_id, $comment_id, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling ModerationApi->postVote: ', $e->getMessage(), PHP_EOL;
27}
28

putAwardBadge Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
badgeIdstringqueryOui
userIdstringqueryNon
commentIdstringqueryNon
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : AwardUserBadgeResponse

Exemple

Exemple putAwardBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
28}
29

putCloseThread Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple putCloseThread
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15$sso = 'sso_example'; // chaîne
16
17
18try {
19 $result = $apiInstance->putCloseThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putCloseThread: ', $e->getMessage(), PHP_EOL;
23}
24

putRemoveBadge Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
badgeIdstringqueryOui
userIdstringqueryNon
commentIdstringqueryNon
broadcastIdstringqueryNon
ssostringqueryNon

Réponse

Renvoie : RemoveUserBadgeResponse

Exemple

putRemoveBadge Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$badge_id = 'badge_id_example'; // string
15$options = [
16 'user_id' => 'user_id_example', // string
17 'comment_id' => 'comment_id_example', // string
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->putRemoveBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->putRemoveBadge: ', $e->getMessage(), PHP_EOL;
28}
29

putReopenThread Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
urlIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple putReopenThread
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15$sso = 'sso_example'; // chaîne
16
17
18try {
19 $result = $apiInstance->putReopenThread($tenant_id, $url_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->putReopenThread: ', $e->getMessage(), PHP_EOL;
23}
24

setTrustFactor Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Réponse

Renvoie : SetUserTrustFactorResponse

Exemple

Exemple setTrustFactor
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'user_id' => 'user_id_example', // string
16 'trust_factor' => 'trust_factor_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->setTrustFactor($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->setTrustFactor: ', $e->getMessage(), PHP_EOL;
26}
27

createModerator Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : CreateModeratorResponse

Exemple

Exemple createModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
21
22
23try {
24 $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
28}
29

deleteModerator Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
sendEmailstringqueryNo

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple deleteModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10// Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
11// Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$send_email = 'send_email_example'; // chaîne
22
23
24try {
25 $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
29}
30

getModerator Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : GetModeratorResponse

Exemple

Exemple getModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getModerator($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception lors de l\'appel de DefaultApi->getModerator : ', $e->getMessage(), PHP_EOL;
28}
29

getModerators Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
skipnumberqueryNon

Réponse

Renvoie : GetModeratorsResponse

Exemple

Exemple getModerators
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$skip = 3.4; // flottant
20
21
22try {
23 $result = $apiInstance->getModerators($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
27}
28

sendInvite Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
fromNamestringqueryOui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple d'envoi d'invitation
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
12 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // chaîne
18$id = 'id_example'; // chaîne
19$from_name = 'from_name_example'; // chaîne
20
21
22try {
23 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception lors de l\'appel de DefaultApi->sendInvite : ', $e->getMessage(), PHP_EOL;
27}
28

updateModerator Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de updateModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
21
22
23try {
24 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
28}
29

deleteNotificationCount Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
28}
29

getCachedNotificationCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringrequêteOui
idstringcheminOui

Réponse

Retourne : GetCachedNotificationCountResponse

Exemple

Exemple getCachedNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
28}
29

getNotificationCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

Réponse

Retourne : GetNotificationCountResponse

Exemple

Exemple getNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommenter ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$options = [
21 'user_id' => 'user_id_example', // chaîne
22 'url_id' => 'url_id_example', // chaîne
23 'from_comment_id' => 'from_comment_id_example', // chaîne
24 'viewed' => True, // booléen
25 'type' => 'type_example', // chaîne
26];
27
28
29try {
30 $result = $apiInstance->getNotificationCount($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
34}
35

getNotifications Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Réponse

Retourne : GetNotificationsResponse

Exemple

Exemple getNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si besoin
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$options = [
21 'user_id' => 'user_id_example', // chaîne
22 'url_id' => 'url_id_example', // chaîne
23 'from_comment_id' => 'from_comment_id_example', // chaîne
24 'viewed' => True, // booléen
25 'type' => 'type_example', // chaîne
26 'skip' => 3.4, // flottant
27];
28
29
30try {
31 $result = $apiInstance->getNotifications($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
35}
36

updateNotification Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de updateNotification
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessus pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
29}
30

createV1PageReact Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
urlIdstringqueryYes
titlestringqueryNo

Réponse

Renvoie : CreateV1PageReact

Exemple

createV1PageReact Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$title = 'title_example'; // string
16
17
18try {
19 $result = $apiInstance->createV1PageReact($tenant_id, $url_id, $title);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->createV1PageReact: ', $e->getMessage(), PHP_EOL;
23}
24

createV2PageReact Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
urlIdstringqueryOui
idstringqueryOui
titlestringqueryNon

Réponse

Renvoie : CreateV1PageReact

Exemple

Exemple createV2PageReact
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16$title = 'title_example'; // string
17
18
19try {
20 $result = $apiInstance->createV2PageReact($tenant_id, $url_id, $id, $title);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->createV2PageReact: ', $e->getMessage(), PHP_EOL;
24}
25

deleteV1PageReact Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringpathYes
urlIdstringqueryYes

Réponse

Renvoie : CreateV1PageReact

Exemple

deleteV1PageReact Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15
16
17try {
18 $result = $apiInstance->deleteV1PageReact($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->deleteV1PageReact: ', $e->getMessage(), PHP_EOL;
22}
23

deleteV2PageReact Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringcheminOui
urlIdstringrequêteOui
idstringrequêteOui

Réponse

Renvoie : CreateV1PageReact

Exemple

deleteV2PageReact Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16
17
18try {
19 $result = $apiInstance->deleteV2PageReact($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->deleteV2PageReact: ', $e->getMessage(), PHP_EOL;
23}
24

getV1PageLikes Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
urlIdstringqueryOui

Réponse

Renvoie : GetV1PageLikes

Exemple

Exemple getV1PageLikes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15
16
17try {
18 $result = $apiInstance->getV1PageLikes($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV1PageLikes: ', $e->getMessage(), PHP_EOL;
22}
23

getV2PageReacts Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
urlIdstringqueryOui

Réponse

Retourne : GetV2PageReacts

Exemple

Exemple getV2PageReacts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15
16
17try {
18 $result = $apiInstance->getV2PageReacts($tenant_id, $url_id);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getV2PageReacts: ', $e->getMessage(), PHP_EOL;
22}
23

getV2PageReactUsers Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringpathOui
urlIdstringqueryOui
idstringqueryOui

Réponse

Retourne : GetV2PageReactUsersResponse

Exemple

Exemple getV2PageReactUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$id = 'id_example'; // string
16
17
18try {
19 $result = $apiInstance->getV2PageReactUsers($tenant_id, $url_id, $id);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getV2PageReactUsers: ', $e->getMessage(), PHP_EOL;
23}
24

addPage Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes

Réponse

Renvoie : AddPageAPIResponse

Exemple

Exemple addPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // C’est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
21
22
23try {
24 $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
28}
29

deletePage Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Retourne : DeletePageAPIResponse

Exemple

Exemple deletePage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deletePage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
28}
29

getOfflineUsers Internal Link

Past commentateurs sur la page qui ne sont PAS actuellement en ligne. Triés par displayName.
Utilisez ceci après avoir épuisé /users/online pour afficher une section « Membres ».
Pagination par curseur sur commenterName : le serveur parcourt la partie {tenantId, urlId, commenterName} indice à partir de afterName vers l’avant via $gt, sans coût $skip.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesIdentifiant d'URL de la page (nettoyé côté serveur).
afterNamestringqueryNoCurseur : transmettre nextAfterName de la réponse précédente.
afterUserIdstringqueryNoCurseur de désambigation : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de noms ne suppriment pas d'entrées.

Response

Renvoie : PageUsersOfflineResponse

Example

Exemple getOfflineUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Identifiant d'URL de la page (nettoyé côté serveur).
15$options = [
16 'after_name' => 'after_name_example', // string | Curseur : transmettre nextAfterName de la réponse précédente.
17 'after_user_id' => 'after_user_id_example', // string | Curseur de désambigation : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de noms ne suppriment pas d'entrées.
18];
19
20
21try {
22 $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
26}
27

getOnlineUsers Internal Link

Currently-online viewers of a page : personnes dont la session websocket est abonnée à la page en ce moment.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathOui
urlIdstringqueryOuiIdentifiant d’URL de page (nettoyé côté serveur).
afterNamestringqueryNonCurseur : transmettre nextAfterName de la réponse précédente.
afterUserIdstringqueryNonCurseur de résolution d’égalité : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom ne suppriment pas d’entrées.

Response

Returns: PageUsersOnlineResponse

Example

Exemple getOnlineUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Identifiant d'URL de page (nettoyé côté serveur).
15$options = [
16 'after_name' => 'after_name_example', // string | Curseur : transmettre nextAfterName de la réponse précédente.
17 'after_user_id' => 'after_user_id_example', // string | Curseur de résolution d'égalité : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom ne suppriment pas d'entrées.
18];
19
20
21try {
22 $result = $apiInstance->getOnlineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOnlineUsers: ', $e->getMessage(), PHP_EOL;
26}
27

getPageByURLId Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
urlIdstringqueryYes

Réponse

Returns: GetPageByURLIdAPIResponse

Exemple

Exemple getPageByURLId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne de caractères
19$url_id = 'url_id_example'; // chaîne de caractères
20
21
22try {
23 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
27}
28

getPages Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes

Réponse

Retourne : GetPagesAPIResponse

Exemple

Exemple getPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20
21
22try {
23 $result = $apiInstance->getPages($tenant_id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
27}
28

getPagesPublic Internal Link

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoCurseur de pagination opaque renvoyé comme nextCursor à partir d'une requête précédente. Lié au même sortBy.
limitintegerqueryNo1..200, défaut 50
qstringqueryNoFiltre de préfixe de titre optionnel, insensible à la casse.
sortBystringqueryNoOrdre de tri. updatedAt (défaut, le plus récent d'abord), commentCount (le plus de commentaires d'abord), ou title (alphabétique).
hasCommentsbooleanqueryNoSi vrai, ne renvoie que les pages contenant au moins un commentaire.

Response

Renvoie : GetPublicPagesResponse

Example

Exemple getPagesPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'cursor' => 'cursor_example', // chaîne | Curseur de pagination opaque renvoyé comme `nextCursor` à partir d'une requête précédente. Lié au même `sortBy`.
16 'limit' => 56, // int | 1..200, défaut 50
17 'q' => 'q_example', // chaîne | Filtre de préfixe de titre optionnel, insensible à la casse.
18 'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | Ordre de tri. `updatedAt` (défaut, le plus récent d'abord), `commentCount` (le plus de commentaires d'abord), ou `title` (alphabétique).
19 'has_comments' => True, // bool | Si vrai, ne renvoie que les pages contenant au moins un commentaire.
20];
21
22
23try {
24 $result = $apiInstance->getPagesPublic($tenant_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->getPagesPublic: ', $e->getMessage(), PHP_EOL;
28}
29

getUsersInfo Internal Link

Informations utilisateur en masse pour un locataire. Étant donné des userIds, renvoie les informations d’affichage provenant 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 uniformément (les profils privés sont masqués).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
idsstringqueryYesIdentifiants d’utilisateurs séparés par des virgules.

Response

Returns: PageUsersInfoResponse

Exemple

Exemple getUsersInfo
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$ids = 'ids_example'; // string | Identifiants d’utilisateurs séparés par des virgules.
15
16
17try {
18 $result = $apiInstance->getUsersInfo($tenant_id, $ids);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUsersInfo: ', $e->getMessage(), PHP_EOL;
22}
23

patchPage Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : PatchPageAPIResponse

Exemple

Exemple de patchPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
22
23
24try {
25 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
29}
30

deletePendingWebhookEvent Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de suppression d'événement de webhook en attente
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
28}
29

getPendingWebhookEventCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
commentIdstringqueryNon
externalIdstringqueryNon
eventTypestringqueryNon
typestringqueryNon
domainstringqueryNon
attemptCountGTnumberqueryNon

Réponse

Renvoie : GetPendingWebhookEventCountResponse

Exemple

Exemple getPendingWebhookEventCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'comment_id' => 'comment_id_example', // string
22 'external_id' => 'external_id_example', // string
23 'event_type' => 'event_type_example', // string
24 'type' => 'type_example', // string
25 'domain' => 'domain_example', // string
26 'attempt_count_gt' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
35}
36

getPendingWebhookEvents Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Réponse

Retourne : GetPendingWebhookEventsResponse

Exemple

Exemple getPendingWebhookEvents
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'comment_id' => 'comment_id_example', // string
21 'external_id' => 'external_id_example', // string
22 'event_type' => 'event_type_example', // string
23 'type' => 'type_example', // string
24 'domain' => 'domain_example', // string
25 'attempt_count_gt' => 3.4, // float
26 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
35}
36

createQuestionConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Renvoie : CreateQuestionConfigResponse

Exemple

Exemple createQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessus pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
12 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
19
20
21try {
22 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
26}
27

deleteQuestionConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple deleteQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29

getQuestionConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : GetQuestionConfigResponse

Exemple

Exemple getQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommenter ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29

getQuestionConfigs Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
skipnumberqueryNo

Réponse

Renvoie : GetQuestionConfigsResponse

Exemple

Exemple getQuestionConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
12 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // chaîne
18$skip = 3.4; // flottant
19
20try {
21 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
25}
26

updateQuestionConfig Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de mise à jour de la configuration de la question
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
22
23
24try {
25 $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
29}
30

createQuestionResult Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : CreateQuestionResultResponse

Exemple

createQuestionResult Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
21
22
23try {
24 $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29

deleteQuestionResult Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de deleteQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29

getQuestionResult Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : GetQuestionResultResponse

Exemple

getQuestionResult Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getQuestionResult($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
28}
29

getQuestionResults Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
urlIdstringqueryNon
userIdstringqueryNon
startDatestringqueryNon
questionIdstringqueryNon
questionIdsstringqueryNon
skipnumberqueryNon

Réponse

Retourne : GetQuestionResultsResponse

Exemple

Exemple getQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$options = [
21 'url_id' => 'url_id_example', // chaîne
22 'user_id' => 'user_id_example', // chaîne
23 'start_date' => 'start_date_example', // chaîne
24 'question_id' => 'question_id_example', // chaîne
25 'question_ids' => 'question_ids_example', // chaîne
26 'skip' => 3.4, // flottant
27];
28
29
30try {
31 $result = $apiInstance->getQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36

updateQuestionResult Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Retourne : APIEmptyResponse

Exemple

Exemple de updateQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
22
23
24try {
25 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
29}
30
---

aggregateQuestionResults Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Réponse

Renvoie : AggregateQuestionResultsResponse

Exemple

Exemple aggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$options = [
20 'question_id' => 'question_id_example', // chaîne
21 'question_ids' => array('question_ids_example'), // string[]
22 'url_id' => 'url_id_example', // chaîne
23 'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
24 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
25 'force_recalculate' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
34}
35

bulkAggregateQuestionResults Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
forceRecalculatebooleanqueryNon

Réponse

Retourne : BulkAggregateQuestionResultsResponse

Exemple

Exemple bulkAggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si besoin
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
21$force_recalculate = True; // booléen
22
23
24try {
25 $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
29}
30

combineCommentsWithQuestionResults Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Réponse

Renvoie : CombineQuestionResultsWithCommentsResponse

Exemple

combineCommentsWithQuestionResults Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé d'API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'question_id' => 'question_id_example', // string
22 'question_ids' => array('question_ids_example'), // string[]
23 'url_id' => 'url_id_example', // string
24 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
25 'force_recalculate' => True, // bool
26 'min_value' => 3.4, // float
27 'max_value' => 3.4, // float
28 'limit' => 3.4, // float
29];
30
31
32try {
33 $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $options);
34 print_r($result);
35} catch (Exception $e) {
36 echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
37}
38

addSSOUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : AddSSOUserAPIResponse

Exemple

Exemple addSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
21
22
23try {
24 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

deleteSSOUser Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Réponse

Retourne : DeleteSSOUserAPIResponse

Exemple

deleteSSOUser Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'delete_comments' => True, // bool
23 'comment_delete_mode' => 'comment_delete_mode_example', // string
24];
25
26
27try {
28 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
32}
33

getSSOUserByEmail Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
emailstringpathYes

Réponse

Retourne : GetSSOUserByEmailAPIResponse

Exemple

Exemple getSSOUserByEmail
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurez l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$email = 'email_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
28}
29

getSSOUserById Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : GetSSOUserByIdAPIResponse

Exemple

Exemple getSSOUserById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getSSOUserById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
28}
29

getSSOUsers Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
skipintegerqueryNo

Réponse

Retourne : GetSSOUsersResponse

Exemple

Exemple getSSOUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$skip = 56; // entier
21
22
23try {
24 $result = $apiInstance->getSSOUsers($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
28}
29

patchSSOUser Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
idstringpathOui
updateCommentsbooleanqueryNon

Réponse

Retourne : PatchSSOUserAPIResponse

Exemple

patchSSOUser Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // bool
23
24
25try {
26 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31

putSSOUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
updateCommentsbooleanqueryNon

Réponse

Renvoie : PutSSOUserAPIResponse

Exemple

Exemple putSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé d'API : api_key
6// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé d'API, si nécessaire
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
22$update_comments = True; // booléen
23
24
25try {
26 $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception lors de l\'appel de DefaultApi->putSSOUser : ', $e->getMessage(), PHP_EOL;
30}
31

createSubscription Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes

Réponse

Retourne : CreateSubscriptionAPIResponse

Exemple

Exemple createSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
21
22
23try {
24 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
28}
29

deleteSubscription Internal Link

Parameters

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Renvoie : DeleteSubscriptionAPIResponse

Example

Exemple de suppression d'abonnement
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$user_id = 'user_id_example'; // chaîne
22
23
24try {
25 $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
29}
30

getSubscriptions Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryNon

Réponse

Renvoie : GetSubscriptionsAPIResponse

Exemple

Exemple getSubscriptions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
28}
29

updateSubscription Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
userIdstringqueryNon

Réponse

Retourne : UpdateSubscriptionAPIResponse

Exemple

Exemple de updateSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
29}
30

getTenantDailyUsages Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
yearNumbernumberqueryNon
monthNumbernumberqueryNon
dayNumbernumberqueryNon
skipnumberqueryNon

Réponse

Renvoie : GetTenantDailyUsagesResponse

Exemple

Exemple getTenantDailyUsages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (par ex., Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'year_number' => 3.4, // float
22 'month_number' => 3.4, // float
23 'day_number' => 3.4, // float
24 'skip' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getTenantDailyUsages($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
33}
34

createTenantPackage Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : CreateTenantPackageResponse

Exemple

Exemple createTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
21
22
23try {
24 $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29

deleteTenantPackage Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de deleteTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour définir le préfixe (ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantPackage Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : GetTenantPackageResponse

Exemple

getTenantPackage Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé d'API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getTenantPackage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantPackages Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
skipnumberqueryNon

Réponse

Retourne : GetTenantPackagesResponse

Exemple

Exemple getTenantPackages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessous pour définir le préfixe (e.g. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$skip = 3.4; // float
20
21
22try {
23 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
27}
28

replaceTenantPackage Internal Link

Parameters

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Response

Renvoie : APIEmptyResponse

Exemple

Exemple replaceTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$id = 'id_example'; // chaîne
20$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
21
22
23try {
24 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
28}
29

updateTenantPackage Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
22
23
24try {
25 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
29}
30

createTenantUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Retourne : CreateTenantUserResponse

Exemple

Exemple createTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
21
22
23try {
24 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

deleteTenantUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
deleteCommentsstringqueryNon
commentDeleteModestringqueryNon

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple de deleteTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'delete_comments' => 'delete_comments_example', // string
23 'comment_delete_mode' => 'comment_delete_mode_example', // string
24];
25
26
27try {
28 $result = $apiInstance->deleteTenantUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
32}
33

getTenantUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Retourne : GetTenantUserResponse

Exemple

Exemple getTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getTenantUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantUsers Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
skipnumberqueryNon

Réponse

Retourne : GetTenantUsersResponse

Exemple

Exemple getTenantUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$skip = 3.4; // flottant
20
21
22try {
23 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
27}
28

replaceTenantUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsstringqueryNo

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple replaceTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé d'API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé d'API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
22$update_comments = 'update_comments_example'; // chaîne
23
24
25try {
26 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
redirectURLstringqueryNon

Réponse

Retourne : APIEmptyResponse

Exemple

sendLoginLink Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommentez ci‑dessous pour définir le préfixe (p. ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$redirect_url = 'redirect_url_example'; // string
21
22
23try {
24 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
28}
29

updateTenantUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
updateCommentsstringqueryNon

Réponse

Returns: APIEmptyResponse

Exemple

Exemple de updateTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
22$update_comments = 'update_comments_example'; // string
23
24
25try {
26 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31

createTenant Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringrequêteOui

Réponse

Renvoie : CreateTenantResponse

Exemple

Exemple createTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
21
22
23try {
24 $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
28}
29

deleteTenant Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes
surestringqueryNo

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple deleteTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$sure = 'sure_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
29}
30

getTenant Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : GetTenantResponse

Exemple

Exemple getTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenant($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
28}
29

getTenants Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
metastringqueryNo
skipnumberqueryNo

Réponse

Retourne : GetTenantsResponse

Exemple

Exemple getTenants
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'meta' => 'meta_example', // string
22 'skip' => 3.4, // float
23];
24
25
26try {
27 $result = $apiInstance->getTenants($tenant_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
31}
32

updateTenant Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptyResponse

Exemple

Exemple updateTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (par ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
21
22
23try {
24 $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
28}
29

changeTicketState Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
userIdstringqueryYes
idstringpathYes

Réponse

Renvoie : ChangeTicketStateResponse

Exemple

changeTicketState Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21$id = 'id_example'; // string
22$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
23
24
25try {
26 $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
30}
31

createTicket Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryOui

Réponse

Renvoie : CreateTicketResponse

Exemple

Exemple createTicket
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$user_id = 'user_id_example'; // chaîne
21$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
22
23
24try {
25 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
29}
30

getTicket Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
userIdstringqueryNon

Réponse

Retourne : GetTicketResponse

Exemple

Exemple getTicket
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
29}
30

getTickets Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryNon
statenumberqueryNon
skipnumberqueryNon
limitnumberqueryNon

Réponse

Retourne : GetTicketsResponse

Exemple

Exemple getTickets
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci-dessous pour configurer le préfixe (ex. Bearer) de la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$options = [
20 'user_id' => 'user_id_example', // chaîne
21 'state' => 3.4, // flottant
22 'skip' => 3.4, // flottant
23 'limit' => 3.4, // flottant
24];
25
26
27try {
28 $result = $apiInstance->getTickets($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
32}
33

getTranslations Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
namespacestringpathOui
componentstringpathOui
localestringqueryNon
useFullTranslationIdsbooleanqueryNon

Réponse

Retourne : GetTranslationsResponse

Exemple

Exemple getTranslations
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$namespace = 'namespace_example'; // chaîne
14$component = 'component_example'; // chaîne
15$options = [
16 'locale' => 'locale_example', // chaîne
17 'use_full_translation_ids' => True, // booléen
18];
19
20
21try {
22 $result = $apiInstance->getTranslations($namespace, $component, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getTranslations: ', $e->getMessage(), PHP_EOL;
26}
27

uploadImage Internal Link

Upload and resize an image

Parameters

NomTypeEmplacementObligatoireDescription
tenantIdstringpathYes
sizePresetstringqueryNoJeu de tailles : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires)
urlIdstringqueryNoID de page depuis lequel le téléversement a lieu, à configurer

Réponse

Retourne : UploadImageResponse

Exemple

Exemple uploadImage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$file = '/path/to/file.txt'; // \SplFileObject
15$options = [
16 'size_preset' => new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(), // \FastComments\Client\Model\SizePreset | Jeu de tailles : \"Default\" (1000x1000px) ou \"CrossPlatform\" (crée des tailles pour les appareils populaires)
17 'url_id' => 'url_id_example', // string | ID de page depuis lequel le téléversement a lieu, à configurer
18];
19
20
21try {
22 $result = $apiInstance->uploadImage($tenant_id, $file, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
26}
27

getUserBadgeProgressById Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIGetUserBadgeProgressResponse

Exemple

Exemple getUserBadgeProgressById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
28}
29

getUserBadgeProgressByUserId Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringpathOui

Réponse

Retourne : APIGetUserBadgeProgressResponse

Exemple

getUserBadgeProgressByUserId Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessus pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$user_id = 'user_id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
28}
29

getUserBadgeProgressList Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryNon
limitnumberqueryNon
skipnumberqueryNon

Réponse

Renvoie : APIGetUserBadgeProgressListResponse

Exemple

Exemple getUserBadgeProgressList
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommenter ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'user_id' => 'user_id_example', // string
21 'limit' => 3.4, // float
22 'skip' => 3.4, // float
23];
24
25
26try {
27 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
31}
32

createUserBadge Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui

Réponse

Renvoie : APICreateUserBadgeResponse

Exemple

Exemple createUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client http personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
21
22
23try {
24 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29

deleteUserBadge Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui

Réponse

Renvoie : APIEmptySuccessResponse

Exemple

Exemple deleteUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9// Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
11// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
12// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
13
14
15$apiInstance = new FastComments\Client\Api\DefaultApi(
16 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
17 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24
25
26try {
27 $result = $apiInstance->deleteUserBadge($tenant_id, $id);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
31}
32

getUserBadge Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : APIGetUserBadgeResponse

Exemple

Exemple getUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configurer l'autorisation de la clé API : api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Décommenter ci-dessous pour configurer le préfixe (par ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21
22try {
23 $result = $apiInstance->getUserBadge($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
27}
28

getUserBadges Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
userIdstringqueryNon
badgeIdstringqueryNon
typenumberqueryNon
displayedOnCommentsbooleanqueryNon
limitnumberqueryNon
skipnumberqueryNon

Réponse

Renvoie : APIGetUserBadgesResponse

Exemple

Exemple getUserBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // chaîne
19$options = [
20 'user_id' => 'user_id_example', // chaîne
21 'badge_id' => 'badge_id_example', // chaîne
22 'type' => 3.4, // flottant
23 'displayed_on_comments' => True, // booléen
24 'limit' => 3.4, // flottant
25 'skip' => 3.4, // flottant
26];
27
28
29try {
30 $result = $apiInstance->getUserBadges($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
34}
35

updateUserBadge Internal Link

Paramètres

NomTypeEmplacementRequisDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Retourne : APIEmptySuccessResponse

Exemple

Exemple updateUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
21
22
23try {
24 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29

getUserNotificationCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
ssostringqueryNon

Réponse

Renvoie : GetUserNotificationCountResponse

Exemple

Exemple getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23

getUserNotifications Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
urlIdstringqueryNonUtilisé pour déterminer si la page actuelle est abonnée.
pageSizeintegerqueryNon
afterIdstringqueryNon
includeContextbooleanqueryNon
afterCreatedAtintegerqueryNon
unreadOnlybooleanqueryNon
dmOnlybooleanqueryNon
noDmbooleanqueryNon
includeTranslationsbooleanqueryNon
includeTenantNotificationsbooleanqueryNon
ssostringqueryNon

Réponse

Renvoie : GetMyNotificationsResponse

Exemple

Exemple getUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'url_id' => 'url_id_example', // chaîne | Utilisé pour déterminer si la page actuelle est abonnée.
16 'page_size' => 56, // int
17 'after_id' => 'after_id_example', // chaîne
18 'include_context' => True, // bool
19 'after_created_at' => 56, // int
20 'unread_only' => True, // bool
21 'dm_only' => True, // bool
22 'no_dm' => True, // bool
23 'include_translations' => True, // bool
24 'include_tenant_notifications' => True, // bool
25 'sso' => 'sso_example', // chaîne
26];
27
28
29try {
30 $result = $apiInstance->getUserNotifications($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
34}
35

resetUserNotificationCount Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
ssostringqueryNo

Réponse

Renvoie : ResetUserNotificationsResponse

Exemple

Exemple de resetUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23

resetUserNotifications Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
afterIdstringqueryNon
afterCreatedAtintegerqueryNon
unreadOnlybooleanqueryNon
dmOnlybooleanqueryNon
noDmbooleanqueryNon
ssostringqueryNon

Réponse

Renvoie : ResetUserNotificationsResponse

Exemple

Exemple resetUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$options = [
15 'after_id' => 'after_id_example', // chaîne
16 'after_created_at' => 56, // entier
17 'unread_only' => True, // booléen
18 'dm_only' => True, // booléen
19 'no_dm' => True, // booléen
20 'sso' => 'sso_example', // chaîne
21];
22
23
24try {
25 $result = $apiInstance->resetUserNotifications($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
29}
30

updateUserNotificationCommentSubscriptionStatus Internal Link

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

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
notificationIdstringpathOui
optedInOrOutstringpathOui
commentIdstringqueryOui
ssostringqueryNon

Réponse

Retourne : UpdateUserNotificationCommentSubscriptionStatusResponse

Exemple

Exemple de updateUserNotificationCommentSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$opted_in_or_out = 'opted_in_or_out_example'; // string
16$comment_id = 'comment_id_example'; // string
17$sso = 'sso_example'; // string
18
19
20try {
21 $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
22 print_r($result);
23} catch (Exception $e) {
24 echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
25}
26

updateUserNotificationPageSubscriptionStatus Internal Link

Enable 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 également

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
urlIdstringqueryOui
urlstringqueryOui
pageTitlestringqueryOui
subscribedOrUnsubscribedstringpathOui
ssostringqueryNon

Réponse

Renvoie : UpdateUserNotificationPageSubscriptionStatusResponse

Exemple

updateUserNotificationPageSubscriptionStatus Exemple
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id = 'url_id_example'; // chaîne
15$url = 'url_example'; // chaîne
16$page_title = 'page_title_example'; // chaîne
17$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // chaîne
18$sso = 'sso_example'; // chaîne
19
20
21try {
22 $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
26}
27

updateUserNotificationStatus Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
notificationIdstringpathOui
newStatusstringpathOui
ssostringqueryNon

Réponse

Retourne : UpdateUserNotificationStatusResponse

Exemple

Exemple updateUserNotificationStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$notification_id = 'notification_id_example'; // string
15$new_status = 'new_status_example'; // string
16$sso = 'sso_example'; // string
17
18
19try {
20 $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
24}
25

getUserPresenceStatuses Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
urlIdWSstringqueryYes
userIdsstringqueryYes

Réponse

Retourne : GetUserPresenceStatusesResponse

Exemple

Exemple getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client http personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // chaîne
14$url_id_ws = 'url_id_ws_example'; // chaîne
15$user_ids = 'user_ids_example'; // chaîne
16
17
18try {
19 $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
23}
24

searchUsers Internal Link

Paramètres

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Réponse

Renvoie : SearchUsersResult

Exemple

Exemple de searchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
9 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'username_starts_with' => 'username_starts_with_example', // string
17 'mention_group_ids' => array('mention_group_ids_example'), // string[]
18 'sso' => 'sso_example', // string
19 'search_section' => 'search_section_example', // string
20];
21
22
23try {
24 $result = $apiInstance->searchUsers($tenant_id, $url_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
28}
29

getUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
idstringpathYes

Réponse

Renvoie : GetUserResponse

Exemple

Exemple getUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Si vous voulez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
13 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20
21
22try {
23 $result = $apiInstance->getUser($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
27}
28

createVote Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Réponse

Renvoie : VoteResponse

Exemple

Exemple createVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$comment_id = 'comment_id_example'; // string
21$direction = 'direction_example'; // string
22$options = [
23 'user_id' => 'user_id_example', // string
24 'anon_user_id' => 'anon_user_id_example', // string
25];
26
27
28try {
29 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
33}
34

deleteVote Internal Link

Parameters

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryOui
idstringpathOui
editKeystringqueryNon

Response

Retourne : VoteDeleteResponse

Example

Exemple deleteVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous voulez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$id = 'id_example'; // chaîne
21$edit_key = 'edit_key_example'; // chaîne
22
23
24try {
25 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
29}
30

getVotes Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
urlIdstringqueryYes

Réponse

Renvoie : GetVotesResponse

Exemple

Exemple getVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l’autorisation de la clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) de la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est facultatif, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$url_id = 'url_id_example'; // chaîne
21
22
23try {
24 $result = $apiInstance->getVotes($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
28}
29

getVotesForUser Internal Link

Paramètres

NomTypeEmplacementObligatoireDescription
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Réponse

Retourne : GetVotesForUserResponse

Exemple

Exemple getVotesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurer l'autorisation de clé API : api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Décommentez ci‑dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Si vous souhaitez utiliser un client HTTP personnalisé, transmettez votre client qui implémente `GuzzleHttp\ClientInterface`.
14 // Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // chaîne
20$url_id = 'url_id_example'; // chaîne
21$options = [
22 'user_id' => 'user_id_example', // chaîne
23 'anon_user_id' => 'anon_user_id_example', // chaîne
24];
25
26
27try {
28 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
32}
33

Besoin d'aide?

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

Contribuer

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