FastComments.com

FastComments SDK для PHP


Це офіційний PHP SDK для FastComments.

Офіційний PHP SDK для API FastComments

Репозиторій

Переглянути на GitHub


Installation & Usage Internal Link


Вимоги

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

Щоб встановити bindings за допомогою Composer, додайте наступне до composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started Internal Link


Будь ласка, дотримуйтесь процедури встановлення, а потім виконайте наступне:

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



// Налаштуйте авторизацію ключем API: api_key
// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Якщо ви хочете використовувати власний http-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // рядок
$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;
}

API Clients Internal Link

The SDK надає три класи клієнтів API:

  • DefaultApi - методи, автентифіковані за допомогою API-ключа, для використання на сервері. Налаштуйте API-ключ, як показано у розділі Getting Started.
  • PublicApi - публічні методи, які не вимагають API-ключа, безпечні для виклику з браузерів та мобільних додатків.
  • ModerationApi - широким набором живих та швидких API модерації. Кожен метод ModerationApi приймає параметр $sso і може автентифікуватися через SSO або cookie сесії FastComments.com.

Використання PublicApi

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

// Public methods do not require an API key.
$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;
}

Використання ModerationApi

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

$apiInstance = new FastComments\Client\Api\ModerationApi(
    new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - SSO payload authenticating the moderator

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

Models Internal Link

Authorization Internal Link


Схеми автентифікації, визначені для API:

api_key

  • Тип: Ключ API
  • Назва параметра ключа API: x-api-key
  • Розташування: заголовок HTTP

Author Internal Link

support@fastcomments.com

aggregate Internal Link

Агрегує документи, групуючи їх (якщо вказано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
parentTenantIdstringqueryНі
includeStatsbooleanqueryНі

Відповідь

Повертає: AggregateResponse

Приклад

Приклад агрегування
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Відповідь

Повертає: GetAuditLogsResponse

Приклад

getAuditLogs Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштувати авторизацію ключа API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, за замовчуванням використовується `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'limit' => 3.4, // float
21 'skip' => 3.4, // float
22 'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
23 'after' => 3.4, // float
24 'before' => 3.4, // float
25];
26
27
28try {
29 $result = $apiInstance->getAuditLogs($tenant_id, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
33}
34

logoutPublic Internal Link

Відповідь

Повертає: APIEmptyResponse

Приклад

logoutPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Відповідь

Повертає: BlockSuccess

Приклад

blockFromCommentPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням використовується `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
16$sso = 'sso_example'; // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Відповідь

Повертає: UnblockSuccess

Приклад

unBlockCommentPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdsstringqueryYesСписок ідентифікаторів коментарів, розділений комами.
ssostringqueryNo

Response

Returns: CheckBlockedCommentsResponse

Example

checkedCommentsForBlocked Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_ids = 'comment_ids_example'; // рядок | Список ідентифікаторів коментарів, розділений комами.
15$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Відповідь

Повертає: BlockSuccess

Приклад

blockUserFromComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо це потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний http-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
22$options = [
23 'user_id' => 'user_id_example', // рядок
24 'anon_user_id' => 'anon_user_id_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathТак
urlIdstringqueryТак
broadcastIdstringqueryТак
sessionIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: SaveCommentsResponseWithPresence

Приклад

Приклад createCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це не обов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
15$broadcast_id = 'broadcast_id_example'; // рядок
16$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
17$options = [
18 'session_id' => 'session_id_example', // рядок
19 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

Відповідь

Повертає: DeleteCommentResult

Приклад

Приклад deleteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API key: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API key, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
20$options = [
21 'context_user_id' => 'context_user_id_example', // рядок
22 'is_live' => True, // булевий
23];
24
25
26try {
27 $result = $apiInstance->deleteComment($tenant_id, $id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
31}
32

deleteCommentPublic Internal Link

Parameters

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Відповідь

Повертає: PublicAPIDeleteCommentResponse

Приклад

deleteCommentPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
commentIdstringpathТак
voteIdstringpathТак
urlIdstringqueryТак
broadcastIdstringqueryТак
editKeystringqueryНі
ssostringqueryНі

Відповідь

Повертає: VoteDeleteResponse

Приклад

deleteCommentVote Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$vote_id = 'vote_id_example'; // рядок
16$url_id = 'url_id_example'; // рядок
17$broadcast_id = 'broadcast_id_example'; // рядок
18$options = [
19 'edit_key' => 'edit_key_example', // рядок
20 'sso' => 'sso_example', // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryТак
idstringpathТак
userIdstringqueryНі
anonUserIdstringqueryНі

Відповідь

Повертає: FlagCommentResponse

Приклад

Приклад flagComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21$options = [
22 'user_id' => 'user_id_example', // рядок
23 'anon_user_id' => 'anon_user_id_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIGetCommentResponse

Приклад

Приклад getComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getComment($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
28}
29

getComments Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

Відповідь

Повертає: APIGetCommentsResponse

Приклад

Приклад getComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$options = [
21 'page' => 56, // int
22 'limit' => 56, // int
23 'skip' => 56, // int
24 'as_tree' => True, // bool
25 'skip_children' => 56, // int
26 'limit_children' => 56, // int
27 'max_tree_depth' => 56, // int
28 'url_id' => 'url_id_example', // string
29 'user_id' => 'user_id_example', // string
30 'anon_user_id' => 'anon_user_id_example', // string
31 'context_user_id' => 'context_user_id_example', // string
32 'hash_tag' => 'hash_tag_example', // string
33 'parent_id' => 'parent_id_example', // string
34 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
35 'from_date' => 56, // int
36 'to_date' => 56, // int
37];
38
39
40try {
41 $result = $apiInstance->getComments($tenant_id, $options);
42 print_r($result);
43} catch (Exception $e) {
44 echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
45}
46

getCommentsPublic Internal Link

req tenantId urlId

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathТак
urlIdstringqueryТак
pageintegerqueryНі
directionstringqueryНі
ssostringqueryНі
skipintegerqueryНі
skipChildrenintegerqueryНі
limitintegerqueryНі
limitChildrenintegerqueryНі
countChildrenbooleanqueryНі
fetchPageForCommentIdstringqueryНі
includeConfigbooleanqueryНі
countAllbooleanqueryНі
includei10nbooleanqueryНі
localestringqueryНі
modulesstringqueryНі
isCrawlerbooleanqueryНі
includeNotificationCountbooleanqueryНі
asTreebooleanqueryНі
maxTreeDepthintegerqueryНі
useFullTranslationIdsbooleanqueryНі
parentIdstringqueryНі
searchTextstringqueryНі
hashTagsarrayqueryНі
userIdstringqueryНі
customConfigStrstringqueryНі
afterCommentIdstringqueryНі
beforeCommentIdstringqueryНі

Відповідь

Повертає: GetCommentsResponseWithPresencePublicComment

Приклад

getCommentsPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathYes
commentIdstringpathYes
editKeystringqueryNo
ssostringqueryNo

Відповідь

Returns: PublicAPIGetCommentTextResponse

Приклад

Приклад getCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Parameters

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Відповідь

Повертає: GetCommentVoteUserNamesSuccessResponse

Приклад

Приклад getCommentVoteUserNames
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$dir = 56; // int
16$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

lockComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власного HTTP‑клієнта, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathТак
commentIdstringpathТак
broadcastIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

pinComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$broadcast_id = 'broadcast_id_example'; // рядок
16$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
isLivebooleanqueryНі
doSpamCheckbooleanqueryНі
sendEmailsbooleanqueryНі
populateNotificationsbooleanqueryНі

Відповідь

Повертає: APISaveCommentResponse

Приклад

Приклад saveComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати кастомний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
21$options = [
22 'is_live' => True, // логічний
23 'do_spam_check' => True, // логічний
24 'send_emails' => True, // логічний
25 'populate_notifications' => True, // логічний
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Відповідь

Повертає: SaveCommentsBulkResponse

Приклад

Приклад saveCommentsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, що реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Відповідь

Повертає: PublicAPISetCommentTextResponse

Приклад

Приклад setCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

Ім'яТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Відповідь

Returns: UnblockSuccess

Приклад

unBlockUserFromComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштування авторизації API ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
25$options = [
26 'user_id' => 'user_id_example', // string
27 'anon_user_id' => 'anon_user_id_example', // string
28];
29
30
31try {
32 $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
33 print_r($result);
34} catch (Exception $e) {
35 echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
36}
37

unFlagComment Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
idstringpathТак
userIdstringqueryНі
anonUserIdstringqueryНі

Відповідь

Повертає: FlagCommentResponse

Приклад

unFlagComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад unLockComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний http‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$broadcast_id = 'broadcast_id_example'; // рядок
16$sso = 'sso_example'; // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

unPinComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний http‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад updateComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію API ключем: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
22$options = [
23 'context_user_id' => 'context_user_id_example', // string
24 'do_spam_check' => True, // bool
25 'is_live' => True, // bool
26];
27
28
29try {
30 $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
31 print_r($result);
32} catch (Exception $e) {
33 echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
34}
35

voteComment Internal Link

Parameters

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
commentIdstringpathТак
urlIdstringqueryТак
broadcastIdstringqueryТак
sessionIdstringqueryНі
ssostringqueryНі

Response

Returns: VoteResponse

Example

Приклад voteComment
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
8// Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
9$apiInstance = new FastComments\Client\Api\PublicApi(
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$url_id = 'url_id_example'; // рядок
16$broadcast_id = 'broadcast_id_example'; // рядок
17$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
18$options = [
19 'session_id' => 'session_id_example', // рядок
20 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Відповідь

Returns: GetCommentsForUserResponse

Приклад

getCommentsForUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$options = [
14 'user_id' => 'user_id_example', // string
15 'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
16 'replies_to_user_id' => 'replies_to_user_id_example', // string
17 'page' => 3.4, // float
18 'includei10n' => True, // bool
19 'locale' => 'locale_example', // string
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: AddDomainConfigResponse

Приклад

addDomainConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
domainstringpathYes

Відповідь

Повертає: DeleteDomainConfigResponse

Приклад

deleteDomainConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштуйте авторизацію ключа API: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, при необхідності
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов’язково, `GuzzleHttp\Client` буде використовуватися за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23// рядок
24$domain = 'domain_example'; // string
25// рядок
26
27
28try {
29 $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
33}
34

getDomainConfig Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
domainstringpathYes

Відповідь

Повертає: GetDomainConfigResponse

Приклад

Приклад getDomainConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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->getDomainConfig($tenant_id, $domain);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
28}
29

getDomainConfigs Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: GetDomainConfigsResponse

Приклад

getDomainConfigs Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, що реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
domainToUpdatestringpathТак

Відповідь

Повертає: PatchDomainConfigResponse

Приклад

patchDomainConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, `GuzzleHttp\Client` буде використаний за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$domain_to_update = 'domain_to_update_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
domainToUpdatestringpathYes

Відповідь

Повертає: PutDomainConfigResponse

Приклад

putDomainConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Відповідь

Повертає: CreateEmailTemplateResponse

Приклад

Приклад createEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deleteEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
28}
29

deleteEmailTemplateRenderError Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes
errorIdstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteEmailTemplateRenderError Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API key: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API key, якщо необхідно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: GetEmailTemplateResponse

Приклад

Приклад getEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
14 // This is optional, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак

Відповідь

Повертає: GetEmailTemplateDefinitionsResponse

Приклад

Приклад getEmailTemplateDefinitions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак
skipnumberqueryНі

Відповідь

Повертає: GetEmailTemplateRenderErrorsResponse

Приклад

Приклад getEmailTemplateRenderErrors
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21$skip = 3.4; // число з плаваючою комою
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
skipnumberqueryNo

Відповідь

Повертає: GetEmailTemplatesResponse

Приклад

Приклад getEmailTemplates
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштуйте авторизацію ключа API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$skip = 3.4; // float
20
21
22try {
23 $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
27}
28

renderEmailTemplate Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
localestringqueryНі

Відповідь

Повертає: RenderEmailTemplateResponse

Приклад

Приклад renderEmailTemplate
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо необхідно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, `GuzzleHttp\Client` буде використаний за замовчуванням.
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

Parameters

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes

Response

Повертає: APIEmptyResponse

Example

updateEmailTemplate Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипLocationRequiredОпис
tenantIdstringpathТак
urlIdstringqueryТак
userIdWSstringqueryТак
startTimeintegerqueryТак
endTimeintegerqueryНі

Відповідь

Повертає: GetEventLogResponse

Приклад

Приклад getEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний http-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням використовується `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
15$user_id_ws = 'user_id_ws_example'; // рядок
16$start_time = 56; // ціле число
17$end_time = 56; // ціле число
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

запит tenantId urlId userIdWS

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringpathТак
urlIdstringqueryТак
userIdWSstringqueryТак
startTimeintegerqueryТак
endTimeintegerqueryНі

Відповідь

Повертає: GetEventLogResponse

Приклад

Приклад getGlobalEventLog
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
broadcastIdstringqueryНі
isLivebooleanqueryНі
doSpamCheckbooleanqueryНі
skipDupCheckbooleanqueryНі

Відповідь

Повертає: CreateFeedPostsResponse

Приклад

Приклад createFeedPost
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації ключа API: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, за потреби
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
20$options = [
21 'broadcast_id' => 'broadcast_id_example', // рядок
22 'is_live' => True, // бул
23 'do_spam_check' => True, // бул
24 'skip_dup_check' => True, // бул
25];
26
27
28try {
29 $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
33}
34

createFeedPostPublic Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Returns: CreateFeedPostResponse

Приклад

createFeedPostPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
26}
27

deleteFeedPostPublic Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: DeleteFeedPostPublicResponse

Приклад

deleteFeedPostPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$post_id = 'post_id_example'; // рядок
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // рядок
17 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

Відповідь

Повертає: GetFeedPostsResponse

Приклад

Приклад getFeedPosts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$options = [
20 'after_id' => 'after_id_example', // string
21 'limit' => 56, // int
22 'tags' => array('tags_example'), // string[]
23];
24
25
26try {
27 $result = $apiInstance->getFeedPosts($tenant_id, $options);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
31}
32

getFeedPostsPublic Internal Link

req tenantId afterId

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringpathТак
afterIdstringqueryНі
limitintegerqueryНі
tagsarrayqueryНі
ssostringqueryНі
isCrawlerbooleanqueryНі
includeUserInfobooleanqueryНі

Відповідь

Повертає: PublicFeedPostsResponse

Приклад

getFeedPostsPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
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

Parameters

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathТак
postIdsarrayqueryТак
ssostringqueryНі

Response

Повертає: FeedPostsStatsResponse

Example

getFeedPostsStats Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$post_ids = array('post_ids_example'); // рядок[]
15$sso = 'sso_example'; // рядок
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

Параметри

Ім’яТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
postIdsarrayqueryНі
ssostringqueryНі

Відповідь

Повертає: UserReactsResponse

Приклад

Приклад getUserReactsPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathYes
postIdstringpathYes
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: ReactFeedPostResponse

Приклад

reactFeedPostPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний http-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

updateFeedPost Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// // Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// // Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: CreateFeedPostResponse

Приклад

updateFeedPostPublic Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$post_id = 'post_id_example'; // string
15$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // string
18 'sso' => 'sso_example', // string
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
isFlaggedbooleanqueryYes
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад flagCommentPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathТак
largeInternalURLSanitizedstringqueryТак

Відповідь

Повертає: GifGetLargeResponse

Приклад

Приклад getGifLarge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathТак
searchstringqueryТак
localestringqueryНі
ratingstringqueryНі
pagenumberqueryНі

Відповідь

Повертає: GetGifsSearchResponse

Приклад

Приклад getGifsSearch
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Відповідь

Повертає: GetGifsTrendingResponse

Приклад

Приклад getGifsTrending
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'locale' => 'locale_example', // рядок
16 'rating' => 'rating_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: CreateHashTagResponse

Приклад

Приклад addHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації за API-ключем: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням використовується `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
21
22
23try {
24 $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
28}
29

addHashTagsBulk Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: BulkCreateHashTagsResponse

Приклад

Приклад addHashTagsBulk
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштуйте авторизацію за допомогою API-ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, за потреби
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
20
21
22try {
23 $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Виняток при виклику DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
27}
28

deleteHashTag Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
tagstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteHashTag Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
pagenumberqueryNo

Відповідь

Повертає: GetHashTagsResponse

Приклад

Приклад getHashTags
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це не обов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
tagstringpathТак

Відповідь

Повертає: UpdateHashTagResponse

Приклад

Приклад patchHashTag
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$tag = 'tag_example'; // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: VoteDeleteResponse

Приклад

deleteModerationVote Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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 'Виняток при виклику ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
27}
28

getApiComments Internal Link

Параметри

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

Відповідь

Повертає: ModerationAPIGetCommentsResponse

Приклад

Приклад getApiComments
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'page' => 3.4, // дробове число
16 'count' => 3.4, // дробове число
17 'text_search' => 'text_search_example', // рядок
18 'by_ip_from_comment' => 'by_ip_from_comment_example', // рядок
19 'filters' => 'filters_example', // рядок
20 'search_filters' => 'search_filters_example', // рядок
21 'sorts' => 'sorts_example', // рядок
22 'demo' => True, // булевий
23 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
batchJobIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: ModerationExportStatusResponse

Приклад

Приклад getApiExportStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'batch_job_id' => 'batch_job_id_example', // рядок
16 'sso' => 'sso_example', // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Відповідь

Повертає: ModerationAPIGetCommentIdsResponse

Приклад

getApiIds Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'text_search' => 'text_search_example', // string
16 'by_ip_from_comment' => 'by_ip_from_comment_example', // string
17 'filters' => 'filters_example', // string
18 'search_filters' => 'search_filters_example', // string
19 'after_id' => 'after_id_example', // string
20 'demo' => True, // bool
21 'sso' => 'sso_example', // string
22];
23
24
25try {
26 $result = $apiInstance->getApiIds($tenant_id, $options);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
30}
31

getBanUsersFromComment Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
commentIdstringpathТак
ssostringqueryНі

Відповідь

Повертає: GetBannedUsersFromCommentResponse

Приклад

getBanUsersFromComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$sso = 'sso_example'; // string
16
17
18try {
19 $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
20 print_r($result);
21} catch (Exception $e) {
22 echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
23}
24

getCommentBanStatus Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Відповідь

Повертає: GetCommentBanStatusResponse

Приклад

Приклад getCommentBanStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Повертає: ModerationAPIChildCommentsResponse

Example

Приклад getCommentChildren
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати кастомний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Відповідь

Повертає: ModerationAPICountCommentsResponse

Приклад

Приклад getCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Returns: GetBannedUsersCountResponse

Приклад

Приклад getCounts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
commentIdstringpathТак
ssostringqueryНі

Відповідь

Повертає: ModerationAPIGetLogsResponse

Приклад

Приклад getLogs
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Повертає: GetTenantManualBadgesResponse

Example

Приклад getManualBadges
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: GetUserManualBadgesResponse

Приклад

Приклад getManualBadgesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'badges_user_id' => 'badges_user_id_example', // string
16 'comment_id' => 'comment_id_example', // string
17 'sso' => 'sso_example', // string
18];
19
20
21try {
22 $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
26}
27

getModerationComment Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
commentIdstringpathТак
includeEmailbooleanqueryНі
includeIPbooleanqueryНі
ssostringqueryНі

Відповідь

Повертає: ModerationAPICommentResponse

Приклад

getModerationComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'include_email' => True, // логічний
17 'include_ip' => True, // логічний
18 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
commentIdstringpathТак
ssostringqueryНі

Відповідь

Повертає: GetCommentTextResponse

Приклад

Приклад getModerationCommentText
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Відповідь

Повертає: PreBanSummary

Приклад

Приклад getPreBanSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'include_by_user_id_and_email' => True, // булевий
17 'include_by_ip' => True, // булевий
18 'include_by_email_domain' => True, // булевий
19 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
valuestringqueryНі
filtersstringqueryНі
searchFiltersstringqueryНі
ssostringqueryНі

Відповідь

Повертає: ModerationCommentSearchResponse

Приклад

Приклад getSearchCommentsSummary
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
valuestringqueryНі
ssostringqueryНі

Відповідь

Повертає: ModerationPageSearchResponse

Приклад

Приклад getSearchPages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
valuestringqueryНі
ssostringqueryНі

Відповідь

Повертає: ModerationSiteSearchResponse

Приклад

getSearchSites Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\ModerationApi(
8// Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9// Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10// );
11$apiInstance = new FastComments\Client\Api\ModerationApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
14 new GuzzleHttp\Client()
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$options = [
19 'value' => 'value_example', // string
20 'sso' => 'sso_example', // string
21];
22
23
24try {
25 $result = $apiInstance->getSearchSites($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
29}
30

getSearchSuggest Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
text-searchstringqueryNo
ssostringqueryNo

Відповідь

Повертає: ModerationSuggestResponse

Приклад

Приклад getSearchSuggest
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати користувацький HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'text_search' => 'text_search_example', // рядок
16 'sso' => 'sso_example', // рядок
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

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
valuestringqueryНі
ssostringqueryНі

Response

Повертає: ModerationUserSearchResponse

Example

Приклад getSearchUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний http‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'value' => 'value_example', // рядок
16 'sso' => 'sso_example', // рядок
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryТак
userIdstringqueryНі
ssostringqueryНі

Response

Повертає: GetUserTrustFactorResponse

Приклад

Приклад getTrustFactor
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: APIModerateGetUserBanPreferencesResponse

Приклад

Приклад getUserBanPreference
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$sso = 'sso_example'; // рядок
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryТак
commentIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: GetUserInternalProfileResponse

Приклад

Приклад getUserInternalProfile
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
commentIdstringpathТак
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: AdjustVotesResponse

Приклад

Приклад postAdjustCommentVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
16$options = [
17 'broadcast_id' => 'broadcast_id_example', // рядок
18 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Відповідь

Повертає: ModerationExportResponse

Приклад

postApiExport Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
commentIdstringpathТак
banEmailbooleanqueryНі
banEmailDomainbooleanqueryНі
banIPbooleanqueryНі
deleteAllUsersCommentsbooleanqueryНі
bannedUntilstringqueryНі
isShadowBanbooleanqueryНі
updateIdstringqueryНі
banReasonstringqueryНі
ssostringqueryНі

Відповідь

Повертає: BanUserFromCommentResult

Приклад

postBanUserFromComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'ban_email' => True, // булевий
17 'ban_email_domain' => True, // булевий
18 'ban_ip' => True, // булевий
19 'delete_all_users_comments' => True, // булевий
20 'banned_until' => 'banned_until_example', // рядок
21 'is_shadow_ban' => True, // булевий
22 'update_id' => 'update_id_example', // рядок
23 'ban_reason' => 'ban_reason_example', // рядок
24 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

postBanUserUndo приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви бажаєте використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
includeByUserIdAndEmailbooleanqueryНі
includeByIPbooleanqueryНі
includeByEmailDomainbooleanqueryНі
ssostringqueryНі

Відповідь

Повертає: BulkPreBanSummary

Приклад

postBulkPreBanSummary Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
15$options = [
16 'include_by_user_id_and_email' => True, // bool
17 'include_by_ip' => True, // bool
18 'include_by_email_domain' => True, // bool
19 'sso' => 'sso_example', // string
20];
21
22
23try {
24 $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
28}
29

postCommentsByIds Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

postCommentsByIds Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
15$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

postFlagComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // рядок
17 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
commentIdstringpathТак
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: PostRemoveCommentApiResponse

Приклад

postRemoveComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
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

Параметри

НазваТипМісцеОбов'язковоОпис
tenantIdstringqueryТак
commentIdstringpathТак
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Returns: APIEmptyResponse

Приклад

postRestoreDeletedComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власного HTTP‑клієнта, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використовуватися `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'broadcast_id' => 'broadcast_id_example', // рядок
17 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
commentIdstringpathТак
approvedbooleanqueryНі
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: SetCommentApprovedResponse

Приклад

Приклад postSetCommentApprovalStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'approved' => True, // логічний
17 'broadcast_id' => 'broadcast_id_example', // рядок
18 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

postSetCommentReviewStatus Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$comment_id = 'comment_id_example'; // рядок
15$options = [
16 'reviewed' => True, // логічний
17 'broadcast_id' => 'broadcast_id_example', // рядок
18 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

postSetCommentSpamStatus Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$comment_id = 'comment_id_example'; // string
15$options = [
16 'spam' => True, // bool
17 'perm_not_spam' => True, // bool
18 'broadcast_id' => 'broadcast_id_example', // string
19 'sso' => 'sso_example', // string
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
commentIdstringpathТак
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: SetCommentTextResponse

Приклад

postSetCommentText Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

postUnFlagComment Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Відповідь

Returns: VoteResponse

Приклад

postVote Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Parameters

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Повертає: AwardUserBadgeResponse

Приклад

Приклад putAwardBadge
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати кастомний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$badge_id = 'badge_id_example'; // рядок
15$options = [
16 'user_id' => 'user_id_example', // рядок
17 'comment_id' => 'comment_id_example', // рядок
18 'broadcast_id' => 'broadcast_id_example', // рядок
19 'sso' => 'sso_example', // рядок
20];
21
22
23try {
24 $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Виключення при виклику ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
28}
29

putCloseThread Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
urlIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

putCloseThread Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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->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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
badgeIdstringqueryТак
userIdstringqueryНі
commentIdstringqueryНі
broadcastIdstringqueryНі
ssostringqueryНі

Відповідь

Повертає: RemoveUserBadgeResponse

Приклад

putRemoveBadge Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$badge_id = 'badge_id_example'; // рядок
15$options = [
16 'user_id' => 'user_id_example', // рядок
17 'comment_id' => 'comment_id_example', // рядок
18 'broadcast_id' => 'broadcast_id_example', // рядок
19 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
urlIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

putReopenThread Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
15$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
userIdstringqueryНі
trustFactorstringqueryНі
ssostringqueryНі

Відповідь

Повертає: SetUserTrustFactorResponse

Приклад

setTrustFactor Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\ModerationApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'user_id' => 'user_id_example', // рядок
16 'trust_factor' => 'trust_factor_example', // рядок
17 'sso' => 'sso_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак

Відповідь

Повертає: CreateModeratorResponse

Приклад

Приклад createModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак
sendEmailstringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteModerator Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприк., Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetModeratorResponse

Приклад

Приклад getModerator
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
skipnumberqueryNo

Відповідь

Повертає: GetModeratorsResponse

Приклад

Приклад getModerators
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// // Налаштувати авторизацію API ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// // Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
10// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
11// // Якщо ви хочете використовувати кастомний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
12// This is optional, `GuzzleHttp\Client` will be used as default.
13// // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
14
15$apiInstance = new FastComments\Client\Api\DefaultApi(
16 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23// // рядок
24$skip = 3.4; // float
25// // float
26
27
28try {
29 $result = $apiInstance->getModerators($tenant_id, $skip);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
33}
34

sendInvite Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак
fromNamestringqueryТак

Відповідь

Повертає: APIEmptyResponse

Приклад

sendInvite Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptyResponse

Приклад

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

deleteNotificationCount Internal Link

Parameters

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Response

Повертає: APIEmptyResponse

Приклад

Приклад deleteNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API-ключа: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: GetCachedNotificationCountResponse

Приклад

Приклад getCachedNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштування авторизації за допомогою API-ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, за потреби
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // рядок
23$id = 'id_example'; // рядок
24
25
26try {
27 $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
28 print_r($result);
29} catch (Exception $e) {
30 echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
31}
32

getNotificationCount Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
userIdstringqueryНі
urlIdstringqueryНі
fromCommentIdstringqueryНі
viewedbooleanqueryНі
typestringqueryНі

Відповідь

Повертає: GetNotificationCountResponse

Приклад

Приклад getNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API-ключем: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$options = [
21 'user_id' => 'user_id_example', // рядок
22 'url_id' => 'url_id_example', // рядок
23 'from_comment_id' => 'from_comment_id_example', // рядок
24 'viewed' => True, // булевий
25 'type' => 'type_example', // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Відповідь

Повертає: GetNotificationsResponse

Приклад

Приклад getNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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 'skip' => 3.4, // float
27];
28
29
30try {
31 $result = $apiInstance->getNotifications($tenant_id, $options);
32 print_r($result);
33} catch (Exception $e) {
34 echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
35}
36

updateNotification Internal Link

Параметри

Ім'яТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак
userIdstringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

updateNotification Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathYes
urlIdstringqueryYes
titlestringqueryNo

Відповідь

Повертає: CreateV1PageReact

Приклад

createV1PageReact Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes
titlestringqueryNo

Відповідь

Повертає: CreateV1PageReact

Приклад

createV2PageReact Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathYes
urlIdstringqueryYes

Відповідь

Повертає: CreateV1PageReact

Приклад

deleteV1PageReact Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\PublicApi(
8// // Якщо ви хочете використати власного HTTP‑клієнта, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9// // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
urlIdstringqueryТак
idstringqueryТак

Відповідь

Повертає: CreateV1PageReact

Приклад

Приклад deleteV2PageReact
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
15$id = 'id_example'; // рядок
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

Параметри

Ім'яТипРозташуванняОбов'язковоОпис
tenantIdstringpathYes
urlIdstringqueryYes

Відповідь

Повертає: GetV1PageLikes

Приклад

Приклад getV1PageLikes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringpathТак
urlIdstringqueryТак

Відповідь

Повертає: GetV2PageReacts

Приклад

Приклад getV2PageReacts
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Відповідь

Повертає: GetV2PageReactUsersResponse

Приклад

Приклад getV2PageReactUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes

Відповідь

Повертає: AddPageAPIResponse

Приклад

addPage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: DeletePageAPIResponse

Приклад

deletePage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21
22
23try {
24 $result = $apiInstance->deletePage($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
28}
29

getOfflineUsers Internal Link

Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesІдентифікатор URL сторінки (очищений на сервері).
afterNamestringqueryNoКурсор: передайте nextAfterName з попередньої відповіді.
afterUserIdstringqueryNoТібрейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути втрати записів через однакові імена.

Response

Returns: PageUsersOfflineResponse

Example

getOfflineUsers Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власного HTTP‑клієнта, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Ідентифікатор URL сторінки (очищений на сервері).
15$options = [
16 'after_name' => 'after_name_example', // string | Курсор: передайте nextAfterName з попередньої відповіді.
17 'after_user_id' => 'after_user_id_example', // string | Тібрейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути втрати записів через однакові імена.
18];
19
20
21try {
22 $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
23 print_r($result);
24} catch (Exception $e) {
25 echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
26}
27

getOnlineUsers Internal Link

Currently-online viewers of a page: 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

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathYes
urlIdstringqueryYesІдентифікатор URL сторінки (очищений на сервері).
afterNamestringqueryNoКурсор: передайте nextAfterName з попередньої відповіді.
afterUserIdstringqueryNoТай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Обов’язково, коли afterName встановлено, щоб уникнути пропуску записів у випадку однакових імен.

Response

Повертає: PageUsersOnlineResponse

Example

Приклад getOnlineUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$url_id = 'url_id_example'; // string | Ідентифікатор URL сторінки (очищений на сервері).
15$options = [
16 'after_name' => 'after_name_example', // string | Курсор: передайте nextAfterName з попередньої відповіді.
17 'after_user_id' => 'after_user_id_example', // string | Тай-брейтер курсора: передайте nextAfterUserId з попередньої відповіді. Обов’язково, коли afterName встановлено, щоб уникнути пропуску записів у випадку однакових імен.
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

Параметри

Ім'яТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
urlIdstringqueryYes

Відповідь

Повертає: GetPageByURLIdAPIResponse

Приклад

Приклад getPageByURLId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes

Відповідь

Повертає: GetPagesAPIResponse

Приклад

getPages Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, за потребою
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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.
Ukrainian: Перелічити сторінки для орендаря. Використовується настільним клієнтом FChat для заповнення списку кімнат.

Requires enableFChat to be true on the resolved custom config for each page.
Ukrainian: Потрібно, щоб enableFChat було true у розв'язаній користувацькій конфігурації для кожної сторінки.

Pages that require SSO are filtered against the requesting user's group access.
Ukrainian: Сторінки, що вимагають SSO, фільтруються згідно з груповим доступом запитуючого користувача.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoНепрозорий курсор пагінації, повернений як nextCursor з попереднього запиту. Пов'язаний з тим же sortBy.
limitintegerqueryNo1..200, за замовчуванням 50
qstringqueryNoНеобов'язковий нечутливий до регістру фільтр префікса назви.
sortBystringqueryNoПорядок сортування. updatedAt (за замовчуванням, спочатку найновіші), commentCount (спочатку з найбільшою кількістю коментарів) або title (за алфавітом).
hasCommentsbooleanqueryNoЯкщо true, повернути лише сторінки, що мають хоча б один коментар.

Response

Повертає: GetPublicPagesResponse

Example

Приклад getPagesPublic
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'cursor' => 'cursor_example', // string | Непрозорий курсор пагінації, повернений як `nextCursor` з попереднього запиту. Пов'язаний з тим же `sortBy`.
16 'limit' => 56, // int | 1..200, за замовчуванням 50
17 'q' => 'q_example', // string | Необов'язковий нечутливий до регістру фільтр префікса назви.
18 'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | Порядок сортування. `updatedAt` (за замовчуванням, спочатку найновіші), `commentCount` (спочатку з найбільшою кількістю коментарів) або `title` (за алфавітом).
19 'has_comments' => True, // bool | Якщо `true`, повернути лише сторінки, що мають хоча б один коментар.
20];
21
22
23try {
24 $result = $apiInstance->getPagesPublic($tenant_id, $options);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Виняток під час виклику 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).

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathТак
idsstringqueryТакКома‑розділені userIds.

Відповідь

Returns: PageUsersInfoResponse

Приклад

Приклад getUsersInfo
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7// $apiInstance = new FastComments\Client\Api\PublicApi(
8// // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9// // Це не обов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10// new GuzzleHttp\Client()
11// );
12
13$tenant_id = 'tenant_id_example'; // string
14$ids = 'ids_example'; // string | Кома‑розділені userIds.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: PatchPageAPIResponse

Приклад

patchPage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштування авторизації API ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно)
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
25
26
27try {
28 $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
32}
33

deletePendingWebhookEvent Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deletePendingWebhookEvent
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Відповідь

Повертає: GetPendingWebhookEventCountResponse

Приклад

Приклад getPendingWebhookEventCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Parameters

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
commentIdstringqueryНі
externalIdstringqueryНі
eventTypestringqueryНі
typestringqueryНі
domainstringqueryНі
attemptCountGTnumberqueryНі
skipnumberqueryНі

Response

Returns: GetPendingWebhookEventsResponse

Приклад

getPendingWebhookEvents Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$options = [
21 'comment_id' => 'comment_id_example', // рядок
22 'external_id' => 'external_id_example', // рядок
23 'event_type' => 'event_type_example', // рядок
24 'type' => 'type_example', // рядок
25 'domain' => 'domain_example', // рядок
26 'attempt_count_gt' => 3.4, // дробове число
27 'skip' => 3.4, // дробове число
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes

Відповідь

Повертає: CreateQuestionConfigResponse

Приклад

Приклад createQuestionConfig
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

Ім'яТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteQuestionConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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->deleteQuestionConfig($tenant_id, $id);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
27}
28

getQuestionConfig Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: GetQuestionConfigResponse

Приклад

getQuestionConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний http‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getQuestionConfig($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
28}
29

getQuestionConfigs Internal Link

Параметри

Ім'яТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
skipnumberqueryNo

Відповідь

Повертає: GetQuestionConfigsResponse

Приклад

getQuestionConfigs Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` will be used as default.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryТак
idstringpathТак

Response

Returns: APIEmptyResponse

Example

updateQuestionConfig Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак

Відповідь

Returns: CreateQuestionResultResponse

Приклад

createQuestionResult Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deleteQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо це необхідно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetQuestionResultResponse

Приклад

Приклад getQuestionResult
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
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->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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
urlIdstringqueryНі
userIdstringqueryНі
startDatestringqueryНі
questionIdstringqueryНі
questionIdsstringqueryНі
skipnumberqueryНі

Відповідь

Повертає: GetQuestionResultsResponse

Приклад

Приклад getQuestionResults
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації за допомогою API‑ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API‑ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$options = [
20 'url_id' => 'url_id_example', // рядок
21 'user_id' => 'user_id_example', // рядок
22 'start_date' => 'start_date_example', // рядок
23 'question_id' => 'question_id_example', // рядок
24 'question_ids' => 'question_ids_example', // рядок
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 'Виняток під час виклику DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
34}
35

updateQuestionResult Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

updateQuestionResult Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
22
23
24try {
25 $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
29}
30

aggregateQuestionResults Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
questionIdstringqueryНі
questionIdsarrayqueryНі
urlIdstringqueryНі
timeBucketstringqueryНі
startDatestringqueryНі
forceRecalculatebooleanqueryНі

Відповідь

Повертає: AggregateQuestionResultsResponse

Приклад

aggregateQuestionResults Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$options = [
21 'question_id' => 'question_id_example', // рядок
22 'question_ids' => array('question_ids_example'), // string[]
23 'url_id' => 'url_id_example', // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
forceRecalculatebooleanqueryNo

Відповідь

Повертає: BulkAggregateQuestionResultsResponse

Приклад

bulkAggregateQuestionResults Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за ключем API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за умовчанням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
21$force_recalculate = True; // булевий
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Відповідь

Повертає: CombineQuestionResultsWithCommentsResponse

Приклад

combineCommentsWithQuestionResults Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$options = [
21 'question_id' => 'question_id_example', // рядок
22 'question_ids' => array('question_ids_example'), // масив рядків
23 'url_id' => 'url_id_example', // рядок
24 'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
25 'force_recalculate' => True, // логічний
26 'min_value' => 3.4, // число з плаваючою комою
27 'max_value' => 3.4, // число з плаваючою комою
28 'limit' => 3.4, // число з плаваючою комою
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: AddSSOUserAPIResponse

Приклад

Приклад addSSOUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви бажаєте використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
21
22
23try {
24 $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
28}
29

deleteSSOUser Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак
deleteCommentsbooleanqueryНі
commentDeleteModestringqueryНі

Відповідь

Returns: DeleteSSOUserAPIResponse

Приклад

deleteSSOUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21$options = [
22 'delete_comments' => True, // булевий
23 'comment_delete_mode' => 'comment_delete_mode_example', // рядок
24];
25
26
27try {
28 $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
32}
33

getSSOUserByEmail Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
emailstringpathYes

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Приклад

Приклад getSSOUserByEmail
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації за допомогою API-ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для API-ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви бажаєте використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це не обов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$email = 'email_example'; // рядок
20
21
22try {
23 $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
27}
28

getSSOUserById Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetSSOUserByIdAPIResponse

Приклад

Приклад getSSOUserById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації через API ключ: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням використовується `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
skipintegerqueryНі

Відповідь

Повертає: GetSSOUsersResponse

Приклад

Приклад getSSOUsers
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$skip = 56; // ціле
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Response

Returns: PatchSSOUserAPIResponse

Example

patchSSOUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштування авторизації API ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23$id = 'id_example'; // string
24$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
25$update_comments = True; // bool
26
27
28try {
29 $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
30 print_r($result);
31} catch (Exception $e) {
32 echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
33}
34

putSSOUser Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Відповідь

Повертає: PutSSOUserAPIResponse

Приклад

putSSOUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

createSubscription Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
20
21
22try {
23 $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
27}
28

deleteSubscription Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Відповідь

Returns: DeleteSubscriptionAPIResponse

Приклад

deleteSubscription Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
21$user_id = 'user_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
userIdstringqueryNo

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад getSubscriptions
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$user_id = 'user_id_example'; // string
21
22
23try {
24 $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
28}
29

updateSubscription Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Відповідь

Повертає: UpdateSubscriptionAPIResponse

Приклад

updateSubscription Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
22$user_id = 'user_id_example'; // string
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
yearNumbernumberqueryНі
monthNumbernumberqueryНі
dayNumbernumberqueryНі
skipnumberqueryНі

Відповідь

Повертає: GetTenantDailyUsagesResponse

Приклад

Приклад getTenantDailyUsages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes

Відповідь

Повертає: CreateTenantPackageResponse

Приклад

createTenantPackage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації за ключем API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deleteTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це не обов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбовʼязковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetTenantPackageResponse

Приклад

Приклад getTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необовʼязково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
skipnumberqueryНі

Відповідь

Повертає: GetTenantPackagesResponse

Приклад

Приклад getTenantPackages
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptyResponse

Приклад

replaceTenantPackage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати кастомний http клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це опціонально, `GuzzleHttp\Client` буде використаний за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад updateTenantPackage
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштування авторизації API ключа: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // рядок
23$id = 'id_example'; // рядок
24$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
25
26
27try {
28 $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
32}
33

createTenantUser Internal Link

Параметри

NameTypeLocationRequiredОпис
tenantIdstringqueryYes

Відповідь

Повертає: CreateTenantUserResponse

Приклад

createTenantUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштуйте авторизацію за допомогою API key: api_key
8$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
9// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
10// Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для API key, якщо потрібно
11// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
12
13
14$apiInstance = new FastComments\Client\Api\DefaultApi(
15 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
16 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
17 // This is optional, `GuzzleHttp\Client` will be used as default.
18 // Це необов'язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
19 new GuzzleHttp\Client(),
20 $config
21);
22
23$tenant_id = 'tenant_id_example'; // string
24$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
25
26
27try {
28 $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
32}
33

deleteTenantUser Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Відповідь

Returns: APIEmptyResponse

Приклад

deleteTenantUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetTenantUserResponse

Приклад

Приклад getTenantUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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->getTenantUser($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
28}
29

getTenantUsers Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
skipnumberqueryНі

Відповідь

Повертає: GetTenantUsersResponse

Приклад

getTenantUsers Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
idstringpathТак
updateCommentsstringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

replaceTenantUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви бажаєте використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
22$update_comments = 'update_comments_example'; // string
23
24
25try {
26 $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
27 print_r($result);
28} catch (Exception $e) {
29 echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
30}
31

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак
redirectURLstringqueryНі

Відповідь

Повертає: APIEmptyResponse

Приклад

sendLoginLink Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштувати авторизацію за допомогою API ключа: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$redirect_url = 'redirect_url_example'; // string
21
22
23try {
24 $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
28}
29

updateTenantUser Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes
updateCommentsstringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

updateTenantUser Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, за потреби
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes

Відповідь

Повертає: CreateTenantResponse

Приклад

createTenant Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, за потреби
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
idstringpathYes
surestringqueryNo

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteTenant Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштуйте авторизацію за допомогою API-ключа: api_key
6// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
7// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
8
9
10$apiInstance = new FastComments\Client\Api\DefaultApi(
11 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
12 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
13 new GuzzleHttp\Client(),
14 $config
15);
16
17$tenant_id = 'tenant_id_example'; // string
18$id = 'id_example'; // string
19$sure = 'sure_example'; // string
20
21
22try {
23 $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
24 print_r($result);
25} catch (Exception $e) {
26 echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
27}
28

getTenant Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetTenantResponse

Приклад

getTenant Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, що реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21
22
23try {
24 $result = $apiInstance->getTenant($tenant_id, $id);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
28}
29

getTenants Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
metastringqueryNo
skipnumberqueryNo

Відповідь

Повертає: GetTenantsResponse

Приклад

Приклад getTenants
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації API ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це опціонально, `GuzzleHttp\Client` буде використаний за замовчуванням.
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 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
30}
31

updateTenant Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptyResponse

Приклад

updateTenant Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації за допомогою API ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
userIdstringqueryYes
idstringpathYes

Відповідь

Повертає: ChangeTicketStateResponse

Приклад

changeTicketState Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте свій клієнт, що реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
userIdstringqueryТак

Відповідь

Повертає: CreateTicketResponse

Приклад

createTicket Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати кастомний http-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$user_id = 'user_id_example'; // рядок
21$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
22
23
24try {
25 $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
29}
30

getTicket Internal Link

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Відповідь

Повертає: GetTicketResponse

Приклад

Приклад getTicket
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$id = 'id_example'; // string
21$user_id = 'user_id_example'; // string
22
23
24try {
25 $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
29}
30

getTickets Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
userIdstringqueryНі
statenumberqueryНі
skipnumberqueryНі
limitnumberqueryНі

Відповідь

Повертає: GetTicketsResponse

Приклад

Приклад getTickets
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5// Налаштування авторизації за допомогою API ключа: api_key
6$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$options = [
20 'user_id' => 'user_id_example', // рядок
21 'state' => 3.4, // число з плаваючою крапкою
22 'skip' => 3.4, // число з плаваючою крапкою
23 'limit' => 3.4, // число з плаваючою крапкою
24];
25
26
27try {
28 $result = $apiInstance->getTickets($tenant_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
32}
33

getTranslations Internal Link

Параметри

Ім'яТипРозташуванняОбов'язковийОпис
namespacestringpathТак
componentstringpathТак
localestringqueryНі
useFullTranslationIdsbooleanqueryНі

Відповідь

Повертає: GetTranslationsResponse

Приклад

Приклад getTranslations
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$namespace = 'namespace_example'; // string
14$component = 'component_example'; // string
15$options = [
16 'locale' => 'locale_example', // string
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

Upload and resize an image

Parameters

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringpathТак
sizePresetstringqueryНіПопередньо визначений розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв)
urlIdstringqueryНіІдентифікатор сторінки, з якої виконується завантаження, для налаштування

Response

Returns: UploadImageResponse

Example

uploadImage Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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 | Попередньо визначений розмір: \"Default\" (1000x1000px) або \"CrossPlatform\" (створює розміри для популярних пристроїв)
17 'url_id' => 'url_id_example', // string | Ідентифікатор сторінки, з якої виконується завантаження, для налаштування
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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад getUserBadgeProgressById
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
userIdstringpathYes

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад getUserBadgeProgressByUserId
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$user_id = 'user_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryТак
userIdstringqueryНі
limitnumberqueryНі
skipnumberqueryНі

Відповідь

Повертає: APIGetUserBadgeProgressListResponse

Приклад

getUserBadgeProgressList Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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 '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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак

Відповідь

Повертає: APICreateUserBadgeResponse

Приклад

createUserBadge Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Configure API key authorization: api_key
7// Налаштуйте авторизацію ключа API: api_key
8// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
9// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
10// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
11
12
13$apiInstance = new FastComments\Client\Api\DefaultApi(
14 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
15 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
16 // This is optional, `GuzzleHttp\Client` will be used as default.
17 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
18 new GuzzleHttp\Client(),
19 $config
20);
21
22$tenant_id = 'tenant_id_example'; // string
23// рядок
24$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
25
26
27try {
28 $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
32}
33

deleteUserBadge Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

Приклад deleteUserBadge
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 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIGetUserBadgeResponse

Приклад

getUserBadge Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
userIdstringqueryНі
badgeIdstringqueryНі
typenumberqueryНі
displayedOnCommentsbooleanqueryНі
limitnumberqueryНі
skipnumberqueryНі

Відповідь

Повертає: APIGetUserBadgesResponse

Приклад

getUserBadges Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// // Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// // Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$options = [
21 'user_id' => 'user_id_example', // рядок
22 'badge_id' => 'badge_id_example', // рядок
23 'type' => 3.4, // float
24 'displayed_on_comments' => True, // булевий
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
idstringpathYes

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

Приклад updateUserBadge
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$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
22
23
24try {
25 $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
29}
30

getUserNotificationCount Internal Link

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: GetUserNotificationCountResponse

Приклад

Приклад getUserNotificationCount
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$sso = 'sso_example'; // string
15
16
17try {
18 $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
19 print_r($result);
20} catch (Exception $e) {
21 echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
22}
23

getUserNotifications Internal Link

Параметри

НазваТипРозташуванняОбов'язковийОпис
tenantIdstringqueryYes
urlIdstringqueryNo
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo
urlIdstringqueryNoВикористовується для визначення, чи підписана поточна сторінка.

Відповідь

Повертає: GetMyNotificationsResponse

Приклад

Приклад getUserNotifications
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов'язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$options = [
15 'url_id' => 'url_id_example', // string | Використовується для визначення, чи підписана поточна сторінка.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
ssostringqueryНі

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

resetUserNotificationCount Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який імплементує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

resetUserNotifications Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$options = [
15 'after_id' => 'after_id_example', // рядок
16 'after_created_at' => 56, // ціле
17 'unread_only' => True, // логічний
18 'dm_only' => True, // логічний
19 'no_dm' => True, // логічний
20 'sso' => 'sso_example', // рядок
21];
22
23
24try {
25 $result = $apiInstance->resetUserNotifications($tenant_id, $options);
26 print_r($result);
27} catch (Exception $e) {
28 echo 'Виняток під час виклику PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
29}
30

updateUserNotificationCommentSubscriptionStatus Internal Link

Увімкнути або вимкнути сповіщення для конкретного коментаря.

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
notificationIdstringpathYes
optedInOrOutstringpathYes
commentIdstringqueryYes
ssostringqueryNo

Відповідь

Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse

Приклад

Приклад updateUserNotificationCommentSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9 // This is optional, `GuzzleHttp\Client` will be used as default.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // string
14$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 або disable сповіщення для сторінки. Коли користувачі підписані на сторінку, сповіщення створюються для нових кореневих коментарів, а також

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

Відповідь

Повертає: UpdateUserNotificationPageSubscriptionStatusResponse

Приклад

Приклад updateUserNotificationPageSubscriptionStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати кастомний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryYes
notificationIdstringpathYes
newStatusstringpathYes
ssostringqueryNo

Відповідь

Повертає: UpdateUserNotificationStatusResponse

Приклад

Приклад updateUserNotificationStatus
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$notification_id = 'notification_id_example'; // рядок
15$new_status = 'new_status_example'; // рядок
16$sso = 'sso_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryТак
urlIdWSstringqueryТак
userIdsstringqueryТак

Відповідь

Повертає: GetUserPresenceStatusesResponse

Приклад

Приклад getUserPresenceStatuses
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringpathТак
urlIdstringqueryТак
usernameStartsWithstringqueryНі
mentionGroupIdsarrayqueryНі
ssostringqueryНі
searchSectionstringqueryНі

Відповідь

Повертає: SearchUsersResult

Приклад

searchUsers Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6
7$apiInstance = new FastComments\Client\Api\PublicApi(
8 // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
9 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
10 new GuzzleHttp\Client()
11);
12
13$tenant_id = 'tenant_id_example'; // рядок
14$url_id = 'url_id_example'; // рядок
15$options = [
16 'username_starts_with' => 'username_starts_with_example', // рядок
17 'mention_group_ids' => array('mention_group_ids_example'), // рядок[]
18 'sso' => 'sso_example', // рядок
19 'search_section' => 'search_section_example', // рядок
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


Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
idstringpathТак

Відповідь

Повертає: GetUserResponse

Приклад

Приклад getUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб задати префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$id = 'id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryТак
commentIdstringqueryТак
directionstringqueryТак
userIdstringqueryНі
anonUserIdstringqueryНі

Відповідь

Повертає: VoteResponse

Приклад

Приклад createVote
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштуйте авторизацію за допомогою API-ключа: api_key
7// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API-ключа, якщо потрібно
8// Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // рядок
19$comment_id = 'comment_id_example'; // рядок
20$direction = 'direction_example'; // рядок
21$options = [
22 'user_id' => 'user_id_example', // рядок
23 'anon_user_id' => 'anon_user_id_example', // рядок
24];
25
26
27try {
28 $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
32}
33

deleteVote Internal Link


Parameters

НазваТипРозташуванняОбов’язковийОпис
tenantIdstringqueryТак
idstringpathТак
editKeystringqueryНі

Response

Повертає: VoteDeleteResponse

Example

deleteVote Приклад
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
8// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
9
10
11$apiInstance = new FastComments\Client\Api\DefaultApi(
12 // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
13 // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
14 new GuzzleHttp\Client(),
15 $config
16);
17
18$tenant_id = 'tenant_id_example'; // string
19$id = 'id_example'; // string
20$edit_key = 'edit_key_example'; // string
21
22
23try {
24 $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
25 print_r($result);
26} catch (Exception $e) {
27 echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
28}
29

getVotes Internal Link

Параметри

НазваТипРозташуванняОбов'язковоОпис
tenantIdstringqueryYes
urlIdstringqueryYes

Відповідь

Повертає: GetVotesResponse

Приклад

Приклад getVotes
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації API ключа: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб налаштувати префікс (наприклад, Bearer) для API ключа, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // рядок
20$url_id = 'url_id_example'; // рядок
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

Параметри

НазваТипРозташуванняОбов’язковоОпис
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Відповідь

Повертає: GetVotesForUserResponse

Приклад

Приклад getVotesForUser
Copy Copy
1
2<?php
3require_once(__DIR__ . '/vendor/autoload.php');
4
5
6// Налаштування авторизації ключа API: api_key
7$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
8// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
9// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
10
11
12$apiInstance = new FastComments\Client\Api\DefaultApi(
13 // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
14 // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
15 new GuzzleHttp\Client(),
16 $config
17);
18
19$tenant_id = 'tenant_id_example'; // string
20$url_id = 'url_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->getVotesForUser($tenant_id, $url_id, $options);
29 print_r($result);
30} catch (Exception $e) {
31 echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
32}
33

Потрібна допомога?

Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо PHP SDK, будь ласка:

Внесок

Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для інструкцій щодо внесків.