FastComments.com

SDK PHP di FastComments


Questo è l'SDK PHP ufficiale per FastComments.

SDK PHP ufficiale per l'API di FastComments

Repository

Visualizza su GitHub


Installazione e utilizzo Internal Link

Requisiti

PHP 7.4 e versioni successive. Dovrebbe funzionare anche con PHP 8.0.

Composer

Per installare i binding tramite Composer, aggiungi quanto segue a composer.json:

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

Poi esegui composer install

Installazione manuale

Scarica i file e includi autoload.php:

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

Primi passi Internal Link

Segui la procedura di installazione e poi esegui quanto segue:

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



// Configura l'autenticazione mediante chiave API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Decommenta la riga sottostante per impostare un prefisso (es. Bearer) per la chiave API, se necessario
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
    // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // stringa
$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;
}

Client API Internal Link

L'SDK espone tre classi client API:

  • DefaultApi - metodi autenticati con chiave API per uso lato server. Configura una chiave API come mostrato in Getting Started.
  • PublicApi - metodi pubblici che non richiedono una chiave API, sicuri da chiamare da browser e app mobili.
  • ModerationApi - una suite completa di API di moderazione in tempo reale e veloce. Ogni metodo ModerationApi accetta un parametro $sso e può autenticarsi tramite SSO o un cookie di sessione FastComments.com.

Utilizzo di PublicApi

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

// I metodi pubblici non richiedono una chiave API.
$apiInstance = new FastComments\Client\Api\PublicApi(
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string

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

Utilizzo di ModerationApi

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

$apiInstance = new FastComments\Client\Api\ModerationApi(
    new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - Payload SSO che autentica il moderatore

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

Modelli Internal Link

Autorizzazione Internal Link


Schemi di autenticazione definiti per l'API:

api_key

  • Tipo: Chiave API
  • Nome del parametro della chiave API: x-api-key
  • Posizione: HTTP header

Autore Internal Link

support@fastcomments.com

aggregate Internal Link

Aggrega i documenti raggruppandoli (se è fornito groupBy) e applicando più operazioni.
Sono supportate diverse operazioni (ad es. sum, countDistinct, avg, ecc.).

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
parentTenantIdstringqueryNo
includeStatsbooleanqueryNo

Risposta

Restituisce: AggregateResponse

Esempio

Esempio di aggregazione
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$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
21$options = [
22 'parent_tenant_id' => 'parent_tenant_id_example', // string
23 'include_stats' => True, // bool
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Risposta

Restituisce: GetAuditLogsResponse

Esempio

Esempio getAuditLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
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

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio logoutPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: BlockSuccess

Esempio

blockFromCommentPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: UnblockSuccess

Esempio

unBlockCommentPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // È opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
21 print_r($result);
22} catch (Exception $e) {
23 echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
24}
25

checkedCommentsForBlocked Internal Link


Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdsstringqueryUn elenco separato da virgole di ID dei commenti.
ssostringqueryNo

Risposta

Restituisce: CheckBlockedCommentsResponse

Esempio

Esempio checkedCommentsForBlocked
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_ids = 'comment_ids_example'; // string | Un elenco separato da virgole di ID dei commenti.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: BlockSuccess

Esempio

Esempio blockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta di seguito per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
21$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // stringa
24 'anon_user_id' => 'anon_user_id_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: SaveCommentsResponseWithPresence

Esempio

createCommentPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
isLivebooleanqueryNo

Risposta

Restituisce: DeleteCommentResult

Esempio

Esempio deleteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$options = [
22 'context_user_id' => 'context_user_id_example', // string
23 'is_live' => True, // bool
24];
25
26
27try {
28 $result = $apiInstance->deleteComment($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
32}
33

deleteCommentPublic Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: PublicAPIDeleteCommentResponse

Esempio

Esempio deleteCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
voteIdstringpath
urlIdstringquery
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: VoteDeleteResponse

Esempio

Esempio deleteCommentVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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$url_id = 'url_id_example'; // string
17$broadcast_id = 'broadcast_id_example'; // string
18$options = [
19 'edit_key' => 'edit_key_example', // string
20 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: FlagCommentResponse

Esempio

Esempio flagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
21$options = [
22 'user_id' => 'user_id_example', // stringa
23 'anon_user_id' => 'anon_user_id_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIGetCommentResponse

Esempio

Esempio getComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Rimuovi il commento qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
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

Parameters

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

Response

Restituisce: APIGetCommentsResponse

Esempio

Esempio getComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'page' => 56, // int
21 'limit' => 56, // int
22 'skip' => 56, // int
23 'as_tree' => True, // bool
24 'skip_children' => 56, // int
25 'limit_children' => 56, // int
26 'max_tree_depth' => 56, // int
27 'url_id' => 'url_id_example', // string
28 'user_id' => 'user_id_example', // string
29 'anon_user_id' => 'anon_user_id_example', // string
30 'context_user_id' => 'context_user_id_example', // string
31 'hash_tag' => 'hash_tag_example', // string
32 'parent_id' => 'parent_id_example', // string
33 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
34 'from_date' => 56, // int
35 'to_date' => 56, // int
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
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

Risposta

Restituisce: GetCommentsResponseWithPresencePublicComment

Esempio

getCommentsPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$options = [
16 'page' => 56, // int
17 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
18 'sso' => 'sso_example', // string
19 'skip' => 56, // int
20 'skip_children' => 56, // int
21 'limit' => 56, // int
22 'limit_children' => 56, // int
23 'count_children' => True, // bool
24 'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // string
25 'include_config' => True, // bool
26 'count_all' => True, // bool
27 'includei10n' => True, // bool
28 'locale' => 'locale_example', // string
29 'modules' => 'modules_example', // string
30 'is_crawler' => True, // bool
31 'include_notification_count' => True, // bool
32 'as_tree' => True, // bool
33 'max_tree_depth' => 56, // int
34 'use_full_translation_ids' => True, // bool
35 'parent_id' => 'parent_id_example', // string
36 'search_text' => 'search_text_example', // string
37 'hash_tags' => array('hash_tags_example'), // string[]
38 'user_id' => 'user_id_example', // string
39 'custom_config_str' => 'custom_config_str_example', // string
40 'after_comment_id' => 'after_comment_id_example', // string
41 'before_comment_id' => 'before_comment_id_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: PublicAPIGetCommentTextResponse

Esempio

getCommentText Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Risposta

Restituisce: GetCommentVoteUserNamesSuccessResponse

Esempio

Esempio getCommentVoteUserNames
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Response

Restituisce: APIEmptyResponse

Example

Esempio lockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Risposta

Restituisce: ChangeCommentPinStatusResponse

Esempio

Esempio pinComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Risposta

Returns: APISaveCommentResponse

Esempio

Esempio saveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
21$options = [
22 'is_live' => True, // booleano
23 'do_spam_check' => True, // booleano
24 'send_emails' => True, // booleano
25 'populate_notifications' => True, // booleano
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Risposta

Restituisce: SaveCommentsBulkResponse

Esempio

Esempio saveCommentsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentare la riga sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
21$options = [
22 'is_live' => True, // bool
23 'do_spam_check' => True, // bool
24 'send_emails' => True, // bool
25 'populate_notifications' => True, // bool
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Risposta

Restituisce: PublicAPISetCommentTextResponse

Esempio

Esempio setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: UnblockSuccess

Esempio

Esempio unBlockUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurare l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentare quanto segue per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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 when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
33}
34

unFlagComment Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: FlagCommentResponse

Esempio

unFlagComment Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio unLockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Risposta

Restituisce: ChangeCommentPinStatusResponse

Esempio

unPinComment Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

updateComment Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
commentIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: VoteResponse

Esempio

Esempio voteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$comment_id = 'comment_id_example'; // stringa
15$url_id = 'url_id_example'; // stringa
16$broadcast_id = 'broadcast_id_example'; // stringa
17$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
18$options = [
19 'session_id' => 'session_id_example', // stringa
20 'sso' => 'sso_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Risposta

Restituisce: GetCommentsForUserResponse

Esempio

Esempio getCommentsForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$options = [
14 'user_id' => 'user_id_example', // stringa
15 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
16 'replies_to_user_id' => 'replies_to_user_id_example', // stringa
17 'page' => 3.4, // float
18 'includei10n' => True, // bool
19 'locale' => 'locale_example', // stringa
20 'is_crawler' => True, // bool
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: AddDomainConfigResponse

Esempio

addDomainConfig Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
21
22
23try {
24 $result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29

deleteDomainConfig Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
domainstringpathYes

Risposta

Restituisce: DeleteDomainConfigResponse

Esempio

Esempio deleteDomainConfig
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$domain = 'domain_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
domainstringpath

Risposta

Restituisce: GetDomainConfigResponse

Esempio

Esempio getDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes

Risposta

Restituisce: GetDomainConfigsResponse

Esempio

Esempio getDomainConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
domainToUpdatestringpath

Risposta

Restituisce: PatchDomainConfigResponse

Esempio

patchDomainConfig Esempio
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$domain_to_update = 'domain_to_update_example'; // string
21$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
22
23
24try {
25 $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
29}
30

putDomainConfig Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
domainToUpdatestringpathYes

Risposta

Restituisce: PutDomainConfigResponse

Esempio

Esempio putDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateEmailTemplateResponse

Esempio

Esempio createEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta quanto segue per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptyResponse

Esempio

deleteEmailTemplate Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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->deleteEmailTemplate($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
27}
28

deleteEmailTemplateRenderError Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
errorIdstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteEmailTemplateRenderError
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$error_id = 'error_id_example'; // string
22
23
24try {
25 $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
29}
30

getEmailTemplate Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetEmailTemplateResponse

Esempio

Esempio getEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: GetEmailTemplateDefinitionsResponse

Esempio

Esempio getEmailTemplateDefinitions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
skipnumberqueryNo

Risposta

Returns: GetEmailTemplateRenderErrorsResponse

Esempio

Esempio getEmailTemplateRenderErrors
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta quanto segue per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$skip = 3.4; // float
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
skipnumberqueryNo

Risposta

Returns: GetEmailTemplatesResponse

Esempio

Esempio getEmailTemplates
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
localestringqueryNo

Risposta

Restituisce: RenderEmailTemplateResponse

Esempio

Esempio renderEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
21$locale = 'locale_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di updateEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerqueryNo

Risposta

Restituisce: GetEventLogResponse

Esempio

Esempio getEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$url_id = 'url_id_example'; // stringa
15$user_id_ws = 'user_id_ws_example'; // stringa
16$start_time = 56; // intero
17$end_time = 56; // intero
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerqueryNo

Risposta

Restituisce: GetEventLogResponse

Esempio

Esempio getGlobalEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\PublicApi(
8// // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9// // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Response

Restituisce: CreateFeedPostsResponse

Esempio

Esempio createFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
21$options = [
22 'broadcast_id' => 'broadcast_id_example', // string
23 'is_live' => True, // bool
24 'do_spam_check' => True, // bool
25 'skip_dup_check' => True, // bool
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: CreateFeedPostResponse

Esempio

Esempio createFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà utilizzato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // stringa
17 'sso' => 'sso_example', // stringa
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 when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27

deleteFeedPostPublic Internal Link

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: DeleteFeedPostPublicResponse

Esempio

Esempio deleteFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
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

req
tenantId
afterId

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

Risposta

Restituisce: GetFeedPostsResponse

Esempio

Esempio getFeedPosts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
12 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$options = [
19 'after_id' => 'after_id_example', // string
20 'limit' => 56, // int
21 'tags' => array('tags_example'), // string[]
22];
23
24try {
25 $result = $apiInstance->getFeedPosts($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
29}
30

getFeedPostsPublic Internal Link

req tenantId afterId

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

Risposta

Restituisce: PublicFeedPostsResponse

Esempio

Esempio getFeedPostsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
postIdsarrayqueryYes
ssostringqueryNo

Risposta

Restituisce: FeedPostsStatsResponse

Esempio

Esempio getFeedPostsStats
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato di default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdsarrayqueryNo
ssostringqueryNo

Risposta

Restituisce: UserReactsResponse

Esempio

Esempio getUserReactsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'post_ids' => array('post_ids_example'), // string[]
16 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: ReactFeedPostResponse

Esempio

reactFeedPostPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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', // string
19 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio updateFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: CreateFeedPostResponse

Esempio

Esempio updateFeedPostPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$post_id = 'post_id_example'; // stringa
15$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // stringa
18 'sso' => 'sso_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
isFlaggedbooleanquery
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

flagCommentPublic Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
largeInternalURLSanitizedstringqueryYes

Risposta

Restituisce: GifGetLargeResponse

Esempio

Esempio getGifLarge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Risposta

Restituisce: GetGifsSearchResponse

Esempio

Esempio getGifsSearch
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$search = 'search_example'; // string
15$options = [
16 'locale' => 'locale_example', // string
17 'rating' => 'rating_example', // string
18 'page' => 3.4, // float
19];
20
21
22try {
23 $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
27}
28

getGifsTrending Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Risposta

Restituisce: GetGifsTrendingResponse

Esempio

Esempio getGifsTrending
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$options = [
15 'locale' => 'locale_example', // stringa
16 'rating' => 'rating_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateHashTagResponse

Esempio

addHashTag Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
20
21
22try {
23 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
27}
28

addHashTagsBulk Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: BulkCreateHashTagsResponse

Esempio

Esempio addHashTagsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta di seguito per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
21
22
23try {
24 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
28}
29

deleteHashTag Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
tagstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

deleteHashTag Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
pagenumberqueryNo

Risposta

Restituisce: GetHashTagsResponse

Esempio

Esempio getHashTags
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Rimuovi il commento qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$page = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getHashTags($tenant_id, $page);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
28}
29

patchHashTag Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
tagstringpath

Risposta

Restituisce: UpdateHashTagResponse

Esempio

patchHashTag Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$tag = 'tag_example'; // string
21$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
22
23
24try {
25 $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
29}
30

deleteModerationVote Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: VoteDeleteResponse

Esempio

Esempio deleteModerationVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationAPIGetCommentsResponse

Esempio

Esempio getApiComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'page' => 3.4, // float
16 'count' => 3.4, // float
17 'text_search' => 'text_search_example', // string
18 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
19 'filters' => 'filters_example', // string
20 'search_filters' => 'search_filters_example', // string
21 'sorts' => 'sorts_example', // string
22 'demo' => True, // bool
23 'sso' => 'sso_example', // string
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationExportStatusResponse

Esempio

Esempio getApiExportStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationAPIGetCommentIdsResponse

Esempio

getApiIds Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$options = [
15 'text_search' => 'text_search_example', // stringa
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // stringa
17 'filters' => 'filters_example', // stringa
18 'search_filters' => 'search_filters_example', // stringa
19 'after_id' => 'after_id_example', // stringa
20 'demo' => True, // bool
21 'sso' => 'sso_example', // stringa
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Response

Restituisce: GetBannedUsersFromCommentResponse

Example

Esempio getBanUsersFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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 'Eccezione durante la chiamata a ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
23}
24

getCommentBanStatus Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: GetCommentBanStatusResponse

Esempio

Esempio getCommentBanStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: ModerationAPIChildCommentsResponse

Esempio

Esempio getCommentChildren
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationAPICountCommentsResponse

Esempio

Esempio getCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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 'filter' => 'filter_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'demo' => True, // bool
20 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: GetBannedUsersCountResponse

Esempio

Esempio getCounts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: ModerationAPIGetLogsResponse

Esempio

Esempio getLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Response

Restituisce: GetTenantManualBadgesResponse

Example

Esempio getManualBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come valore predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$sso = 'sso_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: GetUserManualBadgesResponse

Esempio

Esempio getManualBadgesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$options = [
15 'badges_user_id' => 'badges_user_id_example', // stringa
16 'comment_id' => 'comment_id_example', // stringa
17 'sso' => 'sso_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Risposta

Returns: ModerationAPICommentResponse

Esempio

Esempio di getModerationComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Risposta

Restituisce: GetCommentTextResponse

Esempio

Esempio getModerationCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: PreBanSummary

Esempio

Esempio getPreBanSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
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->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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Response

Restituisce: ModerationCommentSearchResponse

Esempio

getSearchCommentsSummary Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
valuestringqueryNo
ssostringqueryNo

Response

Restituisce: ModerationPageSearchResponse

Example

getSearchPages Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
valuestringqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationSiteSearchResponse

Esempio

Esempio getSearchSites
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
text-searchstringqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationSuggestResponse

Esempio

Esempio getSearchSuggest
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'sso' => 'sso_example', // string
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringquery
valuestringqueryNo
ssostringqueryNo

Response

Restituisce: ModerationUserSearchResponse

Example

Esempio getSearchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
userIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: GetUserTrustFactorResponse

Esempio

Esempio getTrustFactor
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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 when calling ModerationApi->getTrustFactor: ', $e->getMessage(), PHP_EOL;
25}
26

getUserBanPreference Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
ssostringqueryNo

Risposta

Restituisce: APIModerateGetUserBanPreferencesResponse

Esempio

Esempio getUserBanPreference
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: GetUserInternalProfileResponse

Esempio

Esempio getUserInternalProfile
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Restituisce: AdjustVotesResponse

Example

Esempio postAdjustCommentVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Risposta

Restituisce: ModerationExportResponse

Esempio

Esempio postApiExport
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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 'sorts' => 'sorts_example', // string
20 'sso' => 'sso_example', // string
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

Parametri

NameTypeLocationRequiredDescrizione
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

Risposta

Restituisce: BanUserFromCommentResult

Esempio

Esempio postBanUserFromComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'ban_email' => True, // bool
17 'ban_email_domain' => True, // bool
18 'ban_ip' => True, // bool
19 'delete_all_users_comments' => True, // bool
20 'banned_until' => 'banned_until_example', // string
21 'is_shadow_ban' => True, // bool
22 'update_id' => 'update_id_example', // string
23 'ban_reason' => 'ban_reason_example', // string
24 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

postBanUserUndo Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
15$sso = 'sso_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: BulkPreBanSummary

Esempio

Esempio postBulkPreBanSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: ModerationAPIChildCommentsResponse

Esempio

postCommentsByIds Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio postFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` di 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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Returns: PostRemoveCommentApiResponse

Esempio

Esempio postRemoveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio postRestoreDeletedComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` di 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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: SetCommentApprovedResponse

Esempio

Esempio postSetCommentApprovalStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

postSetCommentReviewStatus Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'reviewed' => True, // bool
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio postSetCommentSpamStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$comment_id = 'comment_id_example'; // stringa
15$options = [
16 'spam' => True, // bool
17 'perm_not_spam' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // stringa
19 'sso' => 'sso_example', // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: SetCommentTextResponse

Esempio

Esempio postSetCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
commentIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio postUnFlagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: VoteResponse

Esempio

Esempio postVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` di default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
badgeIdstringquery
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: AwardUserBadgeResponse

Esempio

putAwardBadge Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringquery
ssostringqueryNo

Response

Restituisce: APIEmptyResponse

Example

Esempio putCloseThread
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$url_id = 'url_id_example'; // stringa
15$sso = 'sso_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Risposta

Restituisce: RemoveUserBadgeResponse

Esempio

Esempio putRemoveBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di putReopenThread
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$sso = 'sso_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Risposta

Restituisce: SetUserTrustFactorResponse

Esempio

Esempio setTrustFactor
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateModeratorResponse

Esempio

Esempio createModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
sendEmailstringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$send_email = 'send_email_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetModeratorResponse

Esempio

Esempio getModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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->getModerator($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
28}
29

getModerators Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetModeratorsResponse

Esempio

Esempio getModerators
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getModerators($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
28}
29

sendInvite Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
fromNamestringquery

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio sendInvite
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Rimuovi il commento qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$from_name = 'from_name_example'; // string
22
23
24try {
25 $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
29}
30

updateModerator Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di updateModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
22
23
24try {
25 $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
29}
30

deleteNotificationCount Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come impostazione predefinita.
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->deleteNotificationCount($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
27}
28

getCachedNotificationCount Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetCachedNotificationCountResponse

Esempio

Esempio getCachedNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

Risposta

Restituisce: GetNotificationCountResponse

Esempio

Esempio getNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'user_id' => 'user_id_example', // string
22 'url_id' => 'url_id_example', // string
23 'from_comment_id' => 'from_comment_id_example', // string
24 'viewed' => True, // bool
25 'type' => 'type_example', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetNotificationsResponse

Esempio

getNotifications Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
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 'url_id' => 'url_id_example', // string
22 'from_comment_id' => 'from_comment_id_example', // string
23 'viewed' => True, // bool
24 'type' => 'type_example', // string
25 'skip' => 3.4, // float
26];
27
28
29try {
30 $result = $apiInstance->getNotifications($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
34}
35

updateNotification Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

updateNotification Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
22$user_id = 'user_id_example'; // string
23
24
25try {
26 $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
30}
31

createV1PageReact Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringpath
urlIdstringquery
titlestringqueryNo

Risposta

Restituisce: CreateV1PageReact

Esempio

createV1PageReact Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato di default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
idstringquery
titlestringqueryNo

Risposta

Restituisce: CreateV1PageReact

Esempio

Esempio createV2PageReact
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come default.
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
urlIdstringqueryYes

Response

Restituisce: CreateV1PageReact

Example

Esempio deleteV1PageReact
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà utilizzato come default.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Risposta

Restituisce: CreateV1PageReact

Esempio

Esempio deleteV2PageReact
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery

Risposta

Restituisce: GetV1PageLikes

Esempio

Esempio getV1PageLikes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // È opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$url_id = 'url_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery

Risposta

Restituisce: GetV2PageReacts

Esempio

Esempio getV2PageReacts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Risposta

Restituisce: GetV2PageReactUsersResponse

Esempio

getV2PageReactUsers Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Returns: AddPageAPIResponse

Esempio

Esempio addPage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: DeletePageAPIResponse

Esempio

Esempio deletePage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Rimuovi il commento qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` sarà usato di default.
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->deletePage($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
27}
28

getOfflineUsers Internal Link

Past commentatori sulla pagina che NON sono attualmente online. Ordinati per displayName.
Usa questo dopo aver esaurito /users/online per rendere una sezione “Members”.
Paginazione con cursore su commenterName: il server scorre il sotto‑insieme {tenantId, urlId, commenterName} a partire da afterName in avanti tramite $gt, senza alcun costo $skip.

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpathYes
urlIdstringqueryYesIdentificatore della URL della pagina (ripulito sul server).
afterNamestringqueryNoCursore: passa nextAfterName dalla risposta precedente.
afterUserIdstringqueryNoCursore per risolvere i pareggi: passa nextAfterUserId dalla risposta precedente. Necessario quando afterName è impostato affinché i pareggi di nome non omettano voci.

Risposta

Restituisce: PageUsersOfflineResponse

Esempio

Esempio getOfflineUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Identificatore della URL della pagina (ripulito sul server).
15$options = [
16 'after_name' => 'after_name_example', // string | Cursore: passa **nextAfterName** dalla risposta precedente.
17 'after_user_id' => 'after_user_id_example', // string | Cursore per risolvere i pareggi: passa **nextAfterUserId** dalla risposta precedente. Necessario quando **afterName** è impostato affinché i pareggi di nome non omettano voci.
18];
19
20
21try {
22 $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Eccezione durante la chiamata a PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
26}
27

getOnlineUsers Internal Link

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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringqueryIdentificatore URL della pagina (pulito lato server).
afterNamestringqueryNoCursore: passa nextAfterName dalla risposta precedente.
afterUserIdstringqueryNoCursore per risolvere il pareggio: passa nextAfterUserId dalla risposta precedente. Obbligatorio quando afterName è impostato così i pareggi di nome non eliminano voci.

Response

Restituisce: PageUsersOnlineResponse

Esempio

Esempio getOnlineUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$url_id = 'url_id_example'; // stringa | Identificatore URL della pagina (pulito lato server).
15$options = [
16 'after_name' => 'after_name_example', // stringa | Cursore: passa nextAfterName dalla risposta precedente.
17 'after_user_id' => 'after_user_id_example', // stringa | Cursore per risolvere il pareggio: passa nextAfterUserId dalla risposta precedente. Obbligatorio quando afterName è impostato così i pareggi di nome non eliminano voci.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
urlIdstringqueryYes

Risposta

Restituisce: GetPageByURLIdAPIResponse

Esempio

getPageByURLId Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
28}
29

getPages Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: GetPagesAPIResponse

Esempio

Esempio getPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato di default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
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.
Richiede che enableFChat sia true nella configurazione personalizzata risolta per ogni pagina.
Le pagine che richiedono SSO sono filtrate in base all'accesso del gruppo dell'utente richiedente.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoCursor di paginazione opaco restituito come nextCursor da una richiesta precedente. Legato allo stesso sortBy.
limitintegerqueryNo1..200, default 50
qstringqueryNoFiltro opzionale del prefisso del titolo, non sensibile al maiuscolo/minuscolo.
sortBystringqueryNoOrdine di ordinamento. updatedAt (predefinito, più recenti per primi), commentCount (più commenti per primi) o title (alfabetico).
hasCommentsbooleanqueryNoSe true, restituisce solo le pagine con almeno un commento.

Response

Returns: GetPublicPagesResponse

Example

Esempio getPagesPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'cursor' => 'cursor_example', // string | Cursor di paginazione opaco restituito come `nextCursor` da una richiesta precedente. Legato allo stesso `sortBy`.
16 'limit' => 56, // int | 1..200, default 50
17 'q' => 'q_example', // string | Filtro opzionale del prefisso del titolo, non sensibile al maiuscolo/minuscolo.
18 'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | Ordine di ordinamento. `updatedAt` (predefinito, più recenti per primi), `commentCount` (più commenti per primi) o `title` (alfabetico).
19 'has_comments' => True, // bool | Se true, restituisce solo le pagine con almeno un commento.
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

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
idsstringqueryYesUserIds delimitati da virgola.

Response

Returns: PageUsersInfoResponse

Example

Esempio getUsersInfo
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è facoltativo, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$ids = 'ids_example'; // stringa | UserIds delimitati da virgola.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: PatchPageAPIResponse

Esempio

patchPage Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

deletePendingWebhookEvent Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Risposta

Restituisce: GetPendingWebhookEventCountResponse

Esempio

Esempio getPendingWebhookEventCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configurare l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentare qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetPendingWebhookEventsResponse

Esempio

Esempio getPendingWebhookEvents
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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 'skip' => 3.4, // float
28];
29
30
31try {
32 $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
33 print_r($result);
34} catch (Exception $e) {
35 echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
36}
37

createQuestionConfig Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateQuestionConfigResponse

Esempio

Esempio createQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
21
22
23try {
24 $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29

deleteQuestionConfig Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: GetQuestionConfigResponse

Esempio

Esempio getQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->getQuestionConfig($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28

getQuestionConfigs Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetQuestionConfigsResponse

Esempio

Esempio getQuestionConfigs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
28}
29

updateQuestionConfig Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di updateQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes

Risposta

Restituisce: CreateQuestionResultResponse

Esempio

Esempio createQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: GetQuestionResultResponse

Esempio

getQuestionResult Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetQuestionResultsResponse

Esempio

Esempio getQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Rimuovi il commento qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'url_id' => 'url_id_example', // string
21 'user_id' => 'user_id_example', // string
22 'start_date' => 'start_date_example', // string
23 'question_id' => 'question_id_example', // string
24 'question_ids' => 'question_ids_example', // string
25 'skip' => 3.4, // float
26];
27
28
29try {
30 $result = $apiInstance->getQuestionResults($tenant_id, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
34}
35

updateQuestionResult Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di updateQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Risposta

Restituisce: AggregateQuestionResultsResponse

Esempio

Esempio aggregateQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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 'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
25 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
26 'force_recalculate' => True, // bool
27];
28
29
30try {
31 $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
35}
36

bulkAggregateQuestionResults Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
forceRecalculatebooleanqueryNo

Risposta

Restituisce: BulkAggregateQuestionResultsResponse

Esempio

bulkAggregateQuestionResults Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
21$force_recalculate = True; // bool
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Risposta

Restituisce: CombineQuestionResultsWithCommentsResponse

Esempio

Esempio combineCommentsWithQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: AddSSOUserAPIResponse

Esempio

Esempio addSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione tramite chiave API: api_key
7// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
20
21
22try {
23 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
27}
28

deleteSSOUser Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Risposta

Restituisce: DeleteSSOUserAPIResponse

Esempio

Esempio deleteSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Rimuovi il commento qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // stringa
19$id = 'id_example'; // stringa
20$options = [
21 'delete_comments' => True, // bool
22 'comment_delete_mode' => 'comment_delete_mode_example', // stringa
23];
24
25
26try {
27 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
31}
32

getSSOUserByEmail Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
emailstringpath

Risposta

Restituisce: GetSSOUserByEmailAPIResponse

Esempio

Esempio getSSOUserByEmail
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$email = 'email_example'; // stringa
21
22
23try {
24 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Eccezione durante la chiamata a DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
28}
29

getSSOUserById Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetSSOUserByIdAPIResponse

Esempio

Esempio getSSOUserById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
skipintegerqueryNo

Risposta

Restituisce: GetSSOUsersResponse

Esempio

Esempio getSSOUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 56; // int
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsbooleanqueryNo

Risposta

Restituisce: PatchSSOUserAPIResponse

Esempio

Esempio patchSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsbooleanqueryNo

Risposta

Returns: PutSSOUserAPIResponse

Esempio

Esempio putSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
30}
31

createSubscription Internal Link

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringqueryYes

Risposta

Restituisce: CreateSubscriptionAPIResponse

Esempio

Esempio createSubscription
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
userIdstringqueryNo

Risposta

Restituisce: DeleteSubscriptionAPIResponse

Esempio

deleteSubscription Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
21$user_id = 'user_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo

Risposta

Restituisce: GetSubscriptionsAPIResponse

Esempio

Esempio getSubscriptions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$user_id = 'user_id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Risposta

Restituisce: UpdateSubscriptionAPIResponse

Esempio

updateSubscription Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sottostante per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
21$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
22$user_id = 'user_id_example'; // stringa
23
24
25try {
26 $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
30}
31

getTenantDailyUsages Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: GetTenantDailyUsagesResponse

Esempio

Esempio getTenantDailyUsages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes

Risposta

Restituisce: CreateTenantPackageResponse

Esempio

createTenantPackage Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio di deleteTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenantPackageResponse

Esempio

Esempio getTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
skipnumberqueryNo

Response

Restituisce: GetTenantPackagesResponse

Esempio

Esempio getTenantPackages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getTenantPackages($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
28}
29

replaceTenantPackage Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio replaceTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione con chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
22
23
24try {
25 $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
29}
30

updateTenantPackage Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateTenantUserResponse

Esempio

Esempio createTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà utilizzato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Risposta

Returns: APIEmptyResponse

Esempio

Esempio deleteTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenantUserResponse

Esempio

Esempio getTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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->getTenantUser($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
27}
28

getTenantUsers Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
skipnumberqueryNo

Risposta

Restituisce: GetTenantUsersResponse

Esempio

Esempio getTenantUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$skip = 3.4; // float
21
22
23try {
24 $result = $apiInstance->getTenantUsers($tenant_id, $skip);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
28}
29

replaceTenantUser Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio replaceTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23
24try {
25 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
29}
30

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
redirectURLstringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

sendLoginLink Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
21$redirect_url = 'redirect_url_example'; // stringa
22
23
24try {
25 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
29}
30

updateTenantUser Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio updateTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
21$update_comments = 'update_comments_example'; // string
22
23
24try {
25 $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
29}
30

createTenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: CreateTenantResponse

Esempio

Esempio createTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath
surestringqueryNo

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio deleteTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: GetTenantResponse

Esempio

Esempio getTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$id = 'id_example'; // stringa
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
metastringqueryNo
skipnumberqueryNo

Response

Restituisce: GetTenantsResponse

Example

Esempio getTenants
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se desideri utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come default.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'meta' => 'meta_example', // string
21 'skip' => 3.4, // float
22];
23
24
25try {
26 $result = $apiInstance->getTenants($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Eccezione durante la chiamata DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
30}
31

updateTenant Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptyResponse

Esempio

Esempio updateTenant
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // stringa
19$id = 'id_example'; // stringa
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringquery
idstringpath

Risposta

Restituisce: ChangeTicketStateResponse

Esempio

Esempio changeTicketState
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta quanto segue per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringquery

Risposta

Restituisce: CreateTicketResponse

Esempio

Esempio createTicket
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Decommenta quanto segue per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$user_id = 'user_id_example'; // string
20$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
21
22
23try {
24 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
28}
29

getTicket Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Risposta

Returns: GetTicketResponse

Esempio

Esempio getTicket
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // stringa
19$id = 'id_example'; // stringa
20$user_id = 'user_id_example'; // stringa
21
22
23try {
24 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
28}
29

getTickets Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Risposta

Restituisce: GetTicketsResponse

Esempio

Esempio getTickets
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$options = [
21 'user_id' => 'user_id_example', // stringa
22 'state' => 3.4, // float
23 'skip' => 3.4, // float
24 'limit' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getTickets($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
33}
34

getTranslations Internal Link

Parametri

NameTypeLocationRequiredDescription
namespacestringpathYes
componentstringpathYes
localestringqueryNo
useFullTranslationIdsbooleanqueryNo

Risposta

Restituisce: GetTranslationsResponse

Esempio

Esempio getTranslations
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$namespace = 'namespace_example'; // stringa
14$component = 'component_example'; // stringa
15$options = [
16 'locale' => 'locale_example', // stringa
17 'use_full_translation_ids' => True, // bool
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

Carica e ridimensiona un'immagine

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
sizePresetstringqueryNoPreset di dimensione: "Default" (1000x1000px) o "CrossPlatform" (crea dimensioni per dispositivi popolari)
urlIdstringqueryNoID della pagina da cui avviene il caricamento, da configurare

Response

Restituisce: UploadImageResponse

Esempio

Esempio uploadImage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato di default.
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 | Preset di dimensione: \"Default\" (1000x1000px) o \"CrossPlatform\" (crea dimensioni per dispositivi popolari)
17 'url_id' => 'url_id_example', // string | ID della pagina da cui avviene il caricamento, da configurare
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIGetUserBadgeProgressResponse

Esempio

Esempio getUserBadgeProgressById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringpath

Risposta

Restituisce: APIGetUserBadgeProgressResponse

Esempio

Esempio getUserBadgeProgressByUserId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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->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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
userIdstringqueryNo
limitnumberqueryNo
skipnumberqueryNo

Risposta

Restituisce: APIGetUserBadgeProgressListResponse

Esempio

Esempio getUserBadgeProgressList
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta il seguente per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se desideri utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$options = [
21 'user_id' => 'user_id_example', // stringa
22 'limit' => 3.4, // float
23 'skip' => 3.4, // float
24];
25
26
27try {
28 $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
32}
33

createUserBadge Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery

Risposta

Restituisce: APICreateUserBadgeResponse

Esempio

Esempio createUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIEmptySuccessResponse

Esempio

deleteUserBadge Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta la riga sotto per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
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->deleteUserBadge($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29

getUserBadge Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: APIGetUserBadgeResponse

Esempio

Esempio getUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->getUserBadge($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
28}
29

getUserBadges Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
badgeIdstringqueryNo
typenumberqueryNo
displayedOnCommentsbooleanqueryNo
limitnumberqueryNo
skipnumberqueryNo

Response

Returns: APIGetUserBadgesResponse

Example

Esempio getUserBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione tramite chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommentare la riga sottostante per impostare il prefisso (ad esempio Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // stringa
20$options = [
21 'user_id' => 'user_id_example', // stringa
22 'badge_id' => 'badge_id_example', // stringa
23 'type' => 3.4, // float
24 'displayed_on_comments' => True, // booleano
25 'limit' => 3.4, // float
26 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getUserBadges($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
35}
36

updateUserBadge Internal Link

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
idstringpath

Risposta

Restituisce: APIEmptySuccessResponse

Esempio

Esempio updateUserBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
13 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: GetUserNotificationCountResponse

Esempio

Esempio getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // stringa
14$sso = 'sso_example'; // stringa
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

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringqueryNoUsato per determinare se la pagina corrente è iscritta.
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo

Response

Restituisce: GetMyNotificationsResponse

Example

Esempio getUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'url_id' => 'url_id_example', // string | Usato per determinare se la pagina corrente è iscritta.
16 'page_size' => 56, // int
17 'after_id' => 'after_id_example', // string
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', // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
ssostringqueryNo

Risposta

Restituisce: ResetUserNotificationsResponse

Esempio

Esempio di resetUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneRichiestoDescrizione
tenantIdstringquery
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Risposta

Restituisce: ResetUserNotificationsResponse

Esempio

resetUserNotifications Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'after_id' => 'after_id_example', // string
16 'after_created_at' => 56, // int
17 'unread_only' => True, // bool
18 'dm_only' => True, // bool
19 'no_dm' => True, // bool
20 'sso' => 'sso_example', // string
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

Enable o disabilita le notifiche per un commento specifico.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
optedInOrOutstringpath
commentIdstringquery
ssostringqueryNo

Response

Restituisce: UpdateUserNotificationCommentSubscriptionStatusResponse

Esempio

updateUserNotificationCommentSubscriptionStatus Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
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 o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, le notifiche vengono create per i nuovi commenti radice, e anche

Parameters

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

Response

Restituisce: UpdateUserNotificationPageSubscriptionStatusResponse

Example

updateUserNotificationPageSubscriptionStatus Esempio
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà utilizzato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string
15$url = 'url_example'; // string
16$page_title = 'page_title_example'; // string
17$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
18$sso = 'sso_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
notificationIdstringpath
newStatusstringpath
ssostringqueryNo

Risposta

Restituisce: UpdateUserNotificationStatusResponse

Esempio

Esempio di updateUserNotificationStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, verrà utilizzato `GuzzleHttp\Client` come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdWSstringquery
userIdsstringquery

Risposta

Restituisce: GetUserPresenceStatusesResponse

Esempio

Esempio getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id_ws = 'url_id_ws_example'; // string
15$user_ids = 'user_ids_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringpath
urlIdstringquery
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Risposta

Restituisce: SearchUsersResult

Esempio

Esempio searchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
9 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes

Risposta

Restituisce: GetUserResponse

Esempio

Esempio getUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come predefinito.
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->getUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
28}
29

createVote Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: VoteResponse

Esempio

Esempio createVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi utilizzare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` verrà usato come default.
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
idstringpathYes
editKeystringqueryNo

Risposta

Restituisce: VoteDeleteResponse

Esempio

Esempio di deleteVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$edit_key = 'edit_key_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringquery
urlIdstringquery

Risposta

Restituisce: GetVotesResponse

Esempio

Esempio getVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configura l'autorizzazione della chiave API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Decommenta qui sotto per impostare il prefisso (es. Bearer) per la chiave API, se necessario
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Se vuoi usare un client http personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
14 // Questo è opzionale, `GuzzleHttp\Client` sarà usato come predefinito.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_id_example'; // string
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

Parametri

NomeTipoPosizioneObbligatorioDescrizione
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Risposta

Restituisce: GetVotesForUserResponse

Esempio

Esempio getVotesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Configura l'autorizzazione della chiave API: api_key
6// Decommenta qui sotto per impostare il prefisso (ad es. Bearer) per la chiave API, se necessario
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Se vuoi usare un client HTTP personalizzato, passa il tuo client che implementa `GuzzleHttp\ClientInterface`.
12 // Questo è opzionale, verrà usato `GuzzleHttp\Client` come predefinito.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // stringa
18$url_id = 'url_id_example'; // stringa
19$options = [
20 'user_id' => 'user_id_example', // stringa
21 'anon_user_id' => 'anon_user_id_example', // stringa
22];
23
24
25try {
26 $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
30}
31

Hai bisogno di aiuto?

Se riscontri problemi o hai domande riguardo l'SDK PHP, per favore:

Contribuire

I contributi sono benvenuti! Visita il repository GitHub per le linee guida per i contributi.