FastComments PHP SDK

Это официальный PHP SDK для FastComments.

Официальный PHP SDK для API FastComments

Репозиторий

Просмотреть на GitHub

Установка и использование

Требования

PHP 7.4 и выше.
Также должно работать с PHP 8.0.

Composer

Чтобы установить привязки через Composer, добавьте следующее в composer.json:

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

Затем выполните composer install

Ручная установка

Скачайте файлы и подключите autoload.php:

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

Начало работы

Пожалуйста, выполните процедуру установки и затем запустите следующее:

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



// Настройка авторизации API-ключом: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Если вы хотите использовать собственный HTTP-клиент, передайте клиент, который реализует `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$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

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

Методы API

Все URI относительны к https://fastcomments.com

Класс	Метод	HTTP-запрос
DefaultApi	addDomainConfig	POST /api/v1/domain-configs
DefaultApi	addHashTag	POST /api/v1/hash-tags
DefaultApi	addHashTagsBulk	POST /api/v1/hash-tags/bulk
DefaultApi	addPage	POST /api/v1/pages
DefaultApi	addSSOUser	POST /api/v1/sso-users
DefaultApi	aggregate	POST /api/v1/aggregate
DefaultApi	aggregateQuestionResults	GET /api/v1/question-results-aggregation
DefaultApi	blockUserFromComment	POST /api/v1/comments/{id}/block
DefaultApi	bulkAggregateQuestionResults	POST /api/v1/question-results-aggregation/bulk
DefaultApi	changeTicketState	PATCH /api/v1/tickets/{id}/state
DefaultApi	combineCommentsWithQuestionResults	GET /api/v1/question-results-aggregation/combine/comments
DefaultApi	createEmailTemplate	POST /api/v1/email-templates
DefaultApi	createFeedPost	POST /api/v1/feed-posts
DefaultApi	createModerator	POST /api/v1/moderators
DefaultApi	createQuestionConfig	POST /api/v1/question-configs
DefaultApi	createQuestionResult	POST /api/v1/question-results
DefaultApi	createSubscription	POST /api/v1/subscriptions
DefaultApi	createTenant	POST /api/v1/tenants
DefaultApi	createTenantPackage	POST /api/v1/tenant-packages
DefaultApi	createTenantUser	POST /api/v1/tenant-users
DefaultApi	createTicket	POST /api/v1/tickets
DefaultApi	createUserBadge	POST /api/v1/user-badges
DefaultApi	createVote	POST /api/v1/votes
DefaultApi	deleteComment	DELETE /api/v1/comments/{id}
DefaultApi	deleteDomainConfig	DELETE /api/v1/domain-configs/{domain}
DefaultApi	deleteEmailTemplate	DELETE /api/v1/email-templates/{id}
DefaultApi	deleteEmailTemplateRenderError	DELETE /api/v1/email-templates/{id}/render-errors/{errorId}
DefaultApi	deleteHashTag	DELETE /api/v1/hash-tags/{tag}
DefaultApi	deleteModerator	DELETE /api/v1/moderators/{id}
DefaultApi	deleteNotificationCount	DELETE /api/v1/notification-count/{id}
DefaultApi	deletePage	DELETE /api/v1/pages/{id}
DefaultApi	deletePendingWebhookEvent	DELETE /api/v1/pending-webhook-events/{id}
DefaultApi	deleteQuestionConfig	DELETE /api/v1/question-configs/{id}
DefaultApi	deleteQuestionResult	DELETE /api/v1/question-results/{id}
DefaultApi	deleteSSOUser	DELETE /api/v1/sso-users/{id}
DefaultApi	deleteSubscription	DELETE /api/v1/subscriptions/{id}
DefaultApi	deleteTenant	DELETE /api/v1/tenants/{id}
DefaultApi	deleteTenantPackage	DELETE /api/v1/tenant-packages/{id}
DefaultApi	deleteTenantUser	DELETE /api/v1/tenant-users/{id}
DefaultApi	deleteUserBadge	DELETE /api/v1/user-badges/{id}
DefaultApi	deleteVote	DELETE /api/v1/votes/{id}
DefaultApi	flagComment	POST /api/v1/comments/{id}/flag
DefaultApi	getAuditLogs	GET /api/v1/audit-logs
DefaultApi	getCachedNotificationCount	GET /api/v1/notification-count/{id}
DefaultApi	getComment	GET /api/v1/comments/{id}
DefaultApi	getComments	GET /api/v1/comments
DefaultApi	getDomainConfig	GET /api/v1/domain-configs/{domain}
DefaultApi	getDomainConfigs	GET /api/v1/domain-configs
DefaultApi	getEmailTemplate	GET /api/v1/email-templates/{id}
DefaultApi	getEmailTemplateDefinitions	GET /api/v1/email-templates/definitions
DefaultApi	getEmailTemplateRenderErrors	GET /api/v1/email-templates/{id}/render-errors
DefaultApi	getEmailTemplates	GET /api/v1/email-templates
DefaultApi	getFeedPosts	GET /api/v1/feed-posts
DefaultApi	getHashTags	GET /api/v1/hash-tags
DefaultApi	getModerator	GET /api/v1/moderators/{id}
DefaultApi	getModerators	GET /api/v1/moderators
DefaultApi	getNotificationCount	GET /api/v1/notifications/count
DefaultApi	getNotifications	GET /api/v1/notifications
DefaultApi	getPageByURLId	GET /api/v1/pages/by-url-id
DefaultApi	getPages	GET /api/v1/pages
DefaultApi	getPendingWebhookEventCount	GET /api/v1/pending-webhook-events/count
DefaultApi	getPendingWebhookEvents	GET /api/v1/pending-webhook-events
DefaultApi	getQuestionConfig	GET /api/v1/question-configs/{id}
DefaultApi	getQuestionConfigs	GET /api/v1/question-configs
DefaultApi	getQuestionResult	GET /api/v1/question-results/{id}
DefaultApi	getQuestionResults	GET /api/v1/question-results
DefaultApi	getSSOUserByEmail	GET /api/v1/sso-users/by-email/{email}
DefaultApi	getSSOUserById	GET /api/v1/sso-users/by-id/{id}
DefaultApi	getSSOUsers	GET /api/v1/sso-users
DefaultApi	getSubscriptions	GET /api/v1/subscriptions
DefaultApi	getTenant	GET /api/v1/tenants/{id}
DefaultApi	getTenantDailyUsages	GET /api/v1/tenant-daily-usage
DefaultApi	getTenantPackage	GET /api/v1/tenant-packages/{id}
DefaultApi	getTenantPackages	GET /api/v1/tenant-packages
DefaultApi	getTenantUser	GET /api/v1/tenant-users/{id}
DefaultApi	getTenantUsers	GET /api/v1/tenant-users
DefaultApi	getTenants	GET /api/v1/tenants
DefaultApi	getTicket	GET /api/v1/tickets/{id}
DefaultApi	getTickets	GET /api/v1/tickets
DefaultApi	getUser	GET /api/v1/users/{id}
DefaultApi	getUserBadge	GET /api/v1/user-badges/{id}
DefaultApi	getUserBadgeProgressById	GET /api/v1/user-badge-progress/{id}
DefaultApi	getUserBadgeProgressByUserId	GET /api/v1/user-badge-progress/user/{userId}
DefaultApi	getUserBadgeProgressList	GET /api/v1/user-badge-progress
DefaultApi	getUserBadges	GET /api/v1/user-badges
DefaultApi	getVotes	GET /api/v1/votes
DefaultApi	getVotesForUser	GET /api/v1/votes/for-user
DefaultApi	patchDomainConfig	PATCH /api/v1/domain-configs/{domainToUpdate}
DefaultApi	patchHashTag	PATCH /api/v1/hash-tags/{tag}
DefaultApi	patchPage	PATCH /api/v1/pages/{id}
DefaultApi	patchSSOUser	PATCH /api/v1/sso-users/{id}
DefaultApi	putDomainConfig	PUT /api/v1/domain-configs/{domainToUpdate}
DefaultApi	putSSOUser	PUT /api/v1/sso-users/{id}
DefaultApi	renderEmailTemplate	POST /api/v1/email-templates/render
DefaultApi	replaceTenantPackage	PUT /api/v1/tenant-packages/{id}
DefaultApi	replaceTenantUser	PUT /api/v1/tenant-users/{id}
DefaultApi	saveComment	POST /api/v1/comments
DefaultApi	saveCommentsBulk	POST /api/v1/comments/bulk
DefaultApi	sendInvite	POST /api/v1/moderators/{id}/send-invite
DefaultApi	sendLoginLink	POST /api/v1/tenant-users/{id}/send-login-link
DefaultApi	unBlockUserFromComment	POST /api/v1/comments/{id}/un-block
DefaultApi	unFlagComment	POST /api/v1/comments/{id}/un-flag
DefaultApi	updateComment	PATCH /api/v1/comments/{id}
DefaultApi	updateEmailTemplate	PATCH /api/v1/email-templates/{id}
DefaultApi	updateFeedPost	PATCH /api/v1/feed-posts/{id}
DefaultApi	updateModerator	PATCH /api/v1/moderators/{id}
DefaultApi	updateNotification	PATCH /api/v1/notifications/{id}
DefaultApi	updateQuestionConfig	PATCH /api/v1/question-configs/{id}
DefaultApi	updateQuestionResult	PATCH /api/v1/question-results/{id}
DefaultApi	updateSubscription	PATCH /api/v1/subscriptions/{id}
DefaultApi	updateTenant	PATCH /api/v1/tenants/{id}
DefaultApi	updateTenantPackage	PATCH /api/v1/tenant-packages/{id}
DefaultApi	updateTenantUser	PATCH /api/v1/tenant-users/{id}
DefaultApi	updateUserBadge	PUT /api/v1/user-badges/{id}
ModerationApi	deleteModerationVote	DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId}
ModerationApi	getApiComments	GET /auth/my-account/moderate-comments/api/comments
ModerationApi	getApiExportStatus	GET /auth/my-account/moderate-comments/api/export/status
ModerationApi	getApiIds	GET /auth/my-account/moderate-comments/api/ids
ModerationApi	getBanUsersFromComment	GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId}
ModerationApi	getCommentBanStatus	GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId}
ModerationApi	getCommentChildren	GET /auth/my-account/moderate-comments/comment-children/{commentId}
ModerationApi	getCount	GET /auth/my-account/moderate-comments/count
ModerationApi	getCounts	GET /auth/my-account/moderate-comments/banned-users/counts
ModerationApi	getLogs	GET /auth/my-account/moderate-comments/logs/{commentId}
ModerationApi	getManualBadges	GET /auth/my-account/moderate-comments/get-manual-badges
ModerationApi	getManualBadgesForUser	GET /auth/my-account/moderate-comments/get-manual-badges-for-user
ModerationApi	getModerationComment	GET /auth/my-account/moderate-comments/comment/{commentId}
ModerationApi	getModerationCommentText	GET /auth/my-account/moderate-comments/get-comment-text/{commentId}
ModerationApi	getPreBanSummary	GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId}
ModerationApi	getSearchCommentsSummary	GET /auth/my-account/moderate-comments/search/comments/summary
ModerationApi	getSearchPages	GET /auth/my-account/moderate-comments/search/pages
ModerationApi	getSearchSites	GET /auth/my-account/moderate-comments/search/sites
ModerationApi	getSearchSuggest	GET /auth/my-account/moderate-comments/search/suggest
ModerationApi	getSearchUsers	GET /auth/my-account/moderate-comments/search/users
ModerationApi	getTrustFactor	GET /auth/my-account/moderate-comments/get-trust-factor
ModerationApi	getUserBanPreference	GET /auth/my-account/moderate-comments/user-ban-preference
ModerationApi	getUserInternalProfile	GET /auth/my-account/moderate-comments/get-user-internal-profile
ModerationApi	postAdjustCommentVotes	POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId}
ModerationApi	postApiExport	POST /auth/my-account/moderate-comments/api/export
ModerationApi	postBanUserFromComment	POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId}
ModerationApi	postBanUserUndo	POST /auth/my-account/moderate-comments/ban-user/undo
ModerationApi	postBulkPreBanSummary	POST /auth/my-account/moderate-comments/bulk-pre-ban-summary
ModerationApi	postCommentsByIds	POST /auth/my-account/moderate-comments/comments-by-ids
ModerationApi	postFlagComment	POST /auth/my-account/moderate-comments/flag-comment/{commentId}
ModerationApi	postRemoveComment	POST /auth/my-account/moderate-comments/remove-comment/{commentId}
ModerationApi	postRestoreDeletedComment	POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId}
ModerationApi	postSetCommentApprovalStatus	POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId}
ModerationApi	postSetCommentReviewStatus	POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId}
ModerationApi	postSetCommentSpamStatus	POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId}
ModerationApi	postSetCommentText	POST /auth/my-account/moderate-comments/set-comment-text/{commentId}
ModerationApi	postUnFlagComment	POST /auth/my-account/moderate-comments/un-flag-comment/{commentId}
ModerationApi	postVote	POST /auth/my-account/moderate-comments/vote/{commentId}
ModerationApi	putAwardBadge	PUT /auth/my-account/moderate-comments/award-badge
ModerationApi	putCloseThread	PUT /auth/my-account/moderate-comments/close-thread
ModerationApi	putRemoveBadge	PUT /auth/my-account/moderate-comments/remove-badge
ModerationApi	putReopenThread	PUT /auth/my-account/moderate-comments/reopen-thread
ModerationApi	setTrustFactor	PUT /auth/my-account/moderate-comments/set-trust-factor
PublicApi	blockFromCommentPublic	POST /block-from-comment/{commentId}
PublicApi	checkedCommentsForBlocked	GET /check-blocked-comments
PublicApi	createCommentPublic	POST /comments/{tenantId}
PublicApi	createFeedPostPublic	POST /feed-posts/{tenantId}
PublicApi	createV1PageReact	POST /page-reacts/v1/likes/{tenantId}
PublicApi	createV2PageReact	POST /page-reacts/v2/{tenantId}
PublicApi	deleteCommentPublic	DELETE /comments/{tenantId}/{commentId}
PublicApi	deleteCommentVote	DELETE /comments/{tenantId}/{commentId}/vote/{voteId}
PublicApi	deleteFeedPostPublic	DELETE /feed-posts/{tenantId}/{postId}
PublicApi	deleteV1PageReact	DELETE /page-reacts/v1/likes/{tenantId}
PublicApi	deleteV2PageReact	DELETE /page-reacts/v2/{tenantId}
PublicApi	flagCommentPublic	POST /flag-comment/{commentId}
PublicApi	getCommentText	GET /comments/{tenantId}/{commentId}/text
PublicApi	getCommentVoteUserNames	GET /comments/{tenantId}/{commentId}/votes
PublicApi	getCommentsForUser	GET /comments-for-user
PublicApi	getCommentsPublic	GET /comments/{tenantId}
PublicApi	getEventLog	GET /event-log/{tenantId}
PublicApi	getFeedPostsPublic	GET /feed-posts/{tenantId}
PublicApi	getFeedPostsStats	GET /feed-posts/{tenantId}/stats
PublicApi	getGifLarge	GET /gifs/get-large/{tenantId}
PublicApi	getGifsSearch	GET /gifs/search/{tenantId}
PublicApi	getGifsTrending	GET /gifs/trending/{tenantId}
PublicApi	getGlobalEventLog	GET /event-log/global/{tenantId}
PublicApi	getOfflineUsers	GET /pages/{tenantId}/users/offline
PublicApi	getOnlineUsers	GET /pages/{tenantId}/users/online
PublicApi	getPagesPublic	GET /pages/{tenantId}
PublicApi	getTranslations	GET /translations/{namespace}/{component}
PublicApi	getUserNotificationCount	GET /user-notifications/get-count
PublicApi	getUserNotifications	GET /user-notifications
PublicApi	getUserPresenceStatuses	GET /user-presence-status
PublicApi	getUserReactsPublic	GET /feed-posts/{tenantId}/user-reacts
PublicApi	getUsersInfo	GET /pages/{tenantId}/users/info
PublicApi	getV1PageLikes	GET /page-reacts/v1/likes/{tenantId}
PublicApi	getV2PageReactUsers	GET /page-reacts/v2/{tenantId}/list
PublicApi	getV2PageReacts	GET /page-reacts/v2/{tenantId}
PublicApi	lockComment	POST /comments/{tenantId}/{commentId}/lock
PublicApi	logoutPublic	PUT /auth/logout
PublicApi	pinComment	POST /comments/{tenantId}/{commentId}/pin
PublicApi	reactFeedPostPublic	POST /feed-posts/{tenantId}/react/{postId}
PublicApi	resetUserNotificationCount	POST /user-notifications/reset-count
PublicApi	resetUserNotifications	POST /user-notifications/reset
PublicApi	searchUsers	GET /user-search/{tenantId}
PublicApi	setCommentText	POST /comments/{tenantId}/{commentId}/update-text
PublicApi	unBlockCommentPublic	DELETE /block-from-comment/{commentId}
PublicApi	unLockComment	POST /comments/{tenantId}/{commentId}/unlock
PublicApi	unPinComment	POST /comments/{tenantId}/{commentId}/unpin
PublicApi	updateFeedPostPublic	PUT /feed-posts/{tenantId}/{postId}
PublicApi	updateUserNotificationCommentSubscriptionStatus	POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}
PublicApi	updateUserNotificationPageSubscriptionStatus	POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}
PublicApi	updateUserNotificationStatus	POST /user-notifications/{notificationId}/mark/{newStatus}
PublicApi	uploadImage	POST /upload-image/{tenantId}
PublicApi	voteComment	POST /comments/{tenantId}/{commentId}/vote

Модели

Авторизация

Аутентификационные схемы, определённые для API:

api_key

Тип: API-ключ
Имя параметра API-ключа: x-api-key
Расположение: HTTP-заголовок

Автор

support@fastcomments.com

aggregate

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

Параметры

Имя	Тип	Location	Обязательно
tenantId	string	query	Да
parentTenantId	string	query	Нет
includeStats	boolean	query	Нет

Ответ

Returns: AggregateResponse

Пример

пример агрегирования

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройте авторизацию API‑ключом: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API‑ключа, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$aggregation_request = new \FastComments\Client\Model\AggregationRequest(); // \FastComments\Client\Model\AggregationRequest
$options = [
    'parent_tenant_id' => 'parent_tenant_id_example', // string
    'include_stats' => True, // bool
];
try {
    $result = $apiInstance->aggregate($tenant_id, $aggregation_request, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->aggregate: ', $e->getMessage(), PHP_EOL;
}

getAuditLogs

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

Response

Returns: GetAuditLogsResponse

Example

Приклад getAuditLogs

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$options = [
    'limit' => 3.4, // float
    'skip' => 3.4, // float
    'order' => new \FastComments\Client\Model\\FastComments\Client\Model\SORTDIR(), // \FastComments\Client\Model\SORTDIR
    'after' => 3.4, // float
    'before' => 3.4, // float
];
try {
    $result = $apiInstance->getAuditLogs($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAuditLogs: ', $e->getMessage(), PHP_EOL;
}

logoutPublic

Ответ

Returns: APIEmptyResponse

Пример

Пример logoutPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
try {
    $result = $apiInstance->logoutPublic();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->logoutPublic: ', $e->getMessage(), PHP_EOL;
}

blockFromCommentPublic

Параметры

Name	Type	Location	Required
tenantId	string	query	Да
commentId	string	path	Да
sso	string	query	Нет

Ответ

Возвращает: BlockSuccess

Пример

blockFromCommentPublic Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->blockFromCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->blockFromCommentPublic: ', $e->getMessage(), PHP_EOL;
}

unBlockCommentPublic

Параметри

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

Відповідь

Повертає: UnblockSuccess

Приклад

unBlockCommentPublic Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$comment_id = 'comment_id_example'; // рядок
$public_block_from_comment_params = new \FastComments\Client\Model\PublicBlockFromCommentParams(); // \FastComments\Client\Model\PublicBlockFromCommentParams
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->unBlockCommentPublic($tenant_id, $comment_id, $public_block_from_comment_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unBlockCommentPublic: ', $e->getMessage(), PHP_EOL;
}

checkedCommentsForBlocked

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
commentIds	string	query	Да	Список идентификаторов комментариев, разделённых запятыми.
sso	string	query	Нет

Ответ

Возвращает: CheckBlockedCommentsResponse

Пример

Пример checkedCommentsForBlocked

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте свой клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_ids = 'comment_ids_example'; // string | Список идентификаторов комментариев, разделённых запятыми.
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->checkedCommentsForBlocked($tenant_id, $comment_ids, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->checkedCommentsForBlocked: ', $e->getMessage(), PHP_EOL;
}

blockUserFromComment

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Ответ

Возвращает: BlockSuccess

Пример

Пример blockUserFromComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$block_from_comment_params = new \FastComments\Client\Model\BlockFromCommentParams(); // \FastComments\Client\Model\BlockFromCommentParams
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->blockUserFromComment($tenant_id, $id, $block_from_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->blockUserFromComment: ', $e->getMessage(), PHP_EOL;
}

createCommentPublic

Parameters

Назва	Тип	Розташування	Обов’язковий
tenantId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
sessionId	string	query	Ні
sso	string	query	Ні

Response

Повертає: SaveCommentsResponseWithPresence

Приклад

createCommentPublic Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$comment_data = new \FastComments\Client\Model\CommentData(); // \FastComments\Client\Model\CommentData
$options = [
    'session_id' => 'session_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->createCommentPublic($tenant_id, $url_id, $broadcast_id, $comment_data, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createCommentPublic: ', $e->getMessage(), PHP_EOL;
}

deleteComment

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
isLive	boolean	query	No

Ответ

Возвращает: DeleteCommentResult

Пример

Пример deleteComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'context_user_id' => 'context_user_id_example', // string
    'is_live' => True, // bool
];
try {
    $result = $apiInstance->deleteComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteComment: ', $e->getMessage(), PHP_EOL;
}

deleteCommentPublic

Параметри

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

Відповідь

Повертає: PublicAPIDeleteCommentResponse

Приклад

Приклад deleteCommentPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteCommentPublic($tenant_id, $comment_id, $broadcast_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteCommentPublic: ', $e->getMessage(), PHP_EOL;
}

deleteCommentVote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
voteId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: VoteDeleteResponse

Приклад

deleteCommentVote Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$vote_id = 'vote_id_example'; // string
$url_id = 'url_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteCommentVote($tenant_id, $comment_id, $vote_id, $url_id, $broadcast_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteCommentVote: ', $e->getMessage(), PHP_EOL;
}

flagComment

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Ответ

Возвращает: FlagCommentResponse

Пример

Пример flagComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для ключа API, если необходимо
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// $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'; // string
$id = 'id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->flagComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->flagComment: ', $e->getMessage(), PHP_EOL;
}

getComment

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIGetCommentResponse

Приклад

Приклад getComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getComment($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getComment: ', $e->getMessage(), PHP_EOL;
}

getComments

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
page	integer	query	No
limit	integer	query	No
skip	integer	query	No
asTree	boolean	query	No
skipChildren	integer	query	No
limitChildren	integer	query	No
maxTreeDepth	integer	query	No
urlId	string	query	No
userId	string	query	No
anonUserId	string	query	No
contextUserId	string	query	No
hashTag	string	query	No
parentId	string	query	No
direction	string	query	No
fromDate	integer	query	No
toDate	integer	query	No

Ответ

Возвращает: APIGetCommentsResponse

Пример

Пример getComments

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$options = [
    'page' => 56, // int
    'limit' => 56, // int
    'skip' => 56, // int
    'as_tree' => True, // bool
    'skip_children' => 56, // int
    'limit_children' => 56, // int
    'max_tree_depth' => 56, // int
    'url_id' => 'url_id_example', // string
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
    'context_user_id' => 'context_user_id_example', // string
    'hash_tag' => 'hash_tag_example', // string
    'parent_id' => 'parent_id_example', // string
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'from_date' => 56, // int
    'to_date' => 56, // int
];
try {
    $result = $apiInstance->getComments($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getComments: ', $e->getMessage(), PHP_EOL;
}

getCommentsPublic

req tenantId urlId

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	path	Yes
urlId	string	query	Yes
page	integer	query	No
direction	string	query	No
sso	string	query	No
skip	integer	query	No
skipChildren	integer	query	No
limit	integer	query	No
limitChildren	integer	query	No
countChildren	boolean	query	No
fetchPageForCommentId	string	query	No
includeConfig	boolean	query	No
countAll	boolean	query	No
includei10n	boolean	query	No
locale	string	query	No
modules	string	query	No
isCrawler	boolean	query	No
includeNotificationCount	boolean	query	No
asTree	boolean	query	No
maxTreeDepth	integer	query	No
useFullTranslationIds	boolean	query	No
parentId	string	query	No
searchText	string	query	No
hashTags	array	query	No
userId	string	query	No
customConfigStr	string	query	No
afterCommentId	string	query	No
beforeCommentId	string	query	No

Ответ

Returns: GetCommentsResponseWithPresencePublicComment

Пример

Пример getCommentsPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$options = [
    'page' => 56, // int
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'sso' => 'sso_example', // string
    'skip' => 56, // int
    'skip_children' => 56, // int
    'limit' => 56, // int
    'limit_children' => 56, // int
    'count_children' => True, // bool
    'fetch_page_for_comment_id' => 'fetch_page_for_comment_id_example', // string
    'include_config' => True, // bool
    'count_all' => True, // bool
    'includei10n' => True, // bool
    'locale' => 'locale_example', // string
    'modules' => 'modules_example', // string
    'is_crawler' => True, // bool
    'include_notification_count' => True, // bool
    'as_tree' => True, // bool
    'max_tree_depth' => 56, // int
    'use_full_translation_ids' => True, // bool
    'parent_id' => 'parent_id_example', // string
    'search_text' => 'search_text_example', // string
    'hash_tags' => array('hash_tags_example'), // string[]
    'user_id' => 'user_id_example', // string
    'custom_config_str' => 'custom_config_str_example', // string
    'after_comment_id' => 'after_comment_id_example', // string
    'before_comment_id' => 'before_comment_id_example', // string
];
try {
    $result = $apiInstance->getCommentsPublic($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}

getCommentText

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PublicAPIGetCommentTextResponse

Приклад

Приклад getCommentText

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати кастомний HTTP-клієнт, передайте ваш клиент, який реалізує `GuzzleHttp\ClientInterface`.
    // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'edit_key' => 'edit_key_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getCommentText($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentText: ', $e->getMessage(), PHP_EOL;
}

getCommentVoteUserNames

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	path	Yes
commentId	string	path	Yes
dir	integer	query	Yes
sso	string	query	No

Ответ

Возвращает: GetCommentVoteUserNamesSuccessResponse

Пример

Пример getCommentVoteUserNames

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$dir = 56; // int
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->getCommentVoteUserNames($tenant_id, $comment_id, $dir, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentVoteUserNames: ', $e->getMessage(), PHP_EOL;
}

lockComment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

lockComment Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->lockComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->lockComment: ', $e->getMessage(), PHP_EOL;
}

pinComment

Параметри

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

Відповідь

Returns: ChangeCommentPinStatusResponse

Приклад

Приклад pinComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний http‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->pinComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->pinComment: ', $e->getMessage(), PHP_EOL;
}

saveComment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Відповідь

Повертає: APISaveCommentResponse

Приклад

saveComment Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Налаштуйте авторизацію ключа API: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Розкоментуйте нижче, щоб налаштувати префікс (наприклад Bearer) для ключа API, якщо потрібно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_comment_params = new \FastComments\Client\Model\CreateCommentParams(); // \FastComments\Client\Model\CreateCommentParams
$options = [
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'send_emails' => True, // bool
    'populate_notifications' => True, // bool
];
try {
    $result = $apiInstance->saveComment($tenant_id, $create_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->saveComment: ', $e->getMessage(), PHP_EOL;
}

saveCommentsBulk

Parameters

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Response

Возвращает: SaveCommentsBulkResponse

Example

Пример saveCommentsBulk

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_comment_params = array(new \FastComments\Client\Model\CreateCommentParams()); // \FastComments\Client\Model\CreateCommentParams[]
$options = [
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'send_emails' => True, // bool
    'populate_notifications' => True, // bool
];
try {
    $result = $apiInstance->saveCommentsBulk($tenant_id, $create_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->saveCommentsBulk: ', $e->getMessage(), PHP_EOL;
}

setCommentText

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

Ответ

Возвращает: PublicAPISetCommentTextResponse

Пример

setCommentText Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте свой клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$broadcast_id = 'broadcast_id_example'; // строка
$comment_text_update_request = new \FastComments\Client\Model\CommentTextUpdateRequest(); // \FastComments\Client\Model\CommentTextUpdateRequest
$options = [
    'edit_key' => 'edit_key_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->setCommentText($tenant_id, $comment_id, $broadcast_id, $comment_text_update_request, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->setCommentText: ', $e->getMessage(), PHP_EOL;
}

unBlockUserFromComment

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Returns: UnblockSuccess

Приклад

Приклад unBlockUserFromComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
$un_block_from_comment_params = new \FastComments\Client\Model\UnBlockFromCommentParams(); // \FastComments\Client\Model\UnBlockFromCommentParams
$options = [
    'user_id' => 'user_id_example', // строка
    'anon_user_id' => 'anon_user_id_example', // строка
];
try {
    $result = $apiInstance->unBlockUserFromComment($tenant_id, $id, $un_block_from_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->unBlockUserFromComment: ', $e->getMessage(), PHP_EOL;
}

unFlagComment

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Response

Returns: FlagCommentResponse

Example

Пример unFlagComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Раскомментируйте ниже, чтобы задать префикс (например, Bearer) для API-ключа, если необходимо
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->unFlagComment($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->unFlagComment: ', $e->getMessage(), PHP_EOL;
}

unLockComment

Parameters

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Да
commentId	string	path	Да
broadcastId	string	query	Да
sso	string	query	Нет

Response

Returns: APIEmptyResponse

Example

Пример unLockComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте свой клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$broadcast_id = 'broadcast_id_example'; // строка
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->unLockComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unLockComment: ', $e->getMessage(), PHP_EOL;
}

unPinComment

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	path	Да
commentId	string	path	Да
broadcastId	string	query	Да
sso	string	query	Нет

Ответ

Возвращает: ChangeCommentPinStatusResponse

Пример

Пример unPinComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$broadcast_id = 'broadcast_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->unPinComment($tenant_id, $comment_id, $broadcast_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->unPinComment: ', $e->getMessage(), PHP_EOL;
}

updateComment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
id	string	path	Yes
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

updateComment Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію за допомогою ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$updatable_comment_params = new \FastComments\Client\Model\UpdatableCommentParams(); // \FastComments\Client\Model\UpdatableCommentParams
$options = [
    'context_user_id' => 'context_user_id_example', // string
    'do_spam_check' => True, // bool
    'is_live' => True, // bool
];
try {
    $result = $apiInstance->updateComment($tenant_id, $id, $updatable_comment_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateComment: ', $e->getMessage(), PHP_EOL;
}

voteComment

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Да
commentId	string	path	Да
urlId	string	query	Да
broadcastId	string	query	Да
sessionId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: VoteResponse

Пример

Пример voteComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$url_id = 'url_id_example'; // строка
$broadcast_id = 'broadcast_id_example'; // строка
$vote_body_params = new \FastComments\Client\Model\VoteBodyParams(); // \FastComments\Client\Model\VoteBodyParams
$options = [
    'session_id' => 'session_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->voteComment($tenant_id, $comment_id, $url_id, $broadcast_id, $vote_body_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->voteComment: ', $e->getMessage(), PHP_EOL;
}

getCommentsForUser

Параметри

Назва	Тип	Розташування	Обов’язковий
userId	string	query	No
direction	string	query	No
repliesToUserId	string	query	No
page	number	query	No
includei10n	boolean	query	No
locale	string	query	No
isCrawler	boolean	query	No

Відповідь

Повертає: GetCommentsForUserResponse

Приклад

Приклад getCommentsForUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний http-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$options = [
    'user_id' => 'user_id_example', // рядок
    'direction' => new \FastComments\Client\Model\\FastComments\Client\Model\SortDirections(), // \FastComments\Client\Model\SortDirections
    'replies_to_user_id' => 'replies_to_user_id_example', // рядок
    'page' => 3.4, // число
    'includei10n' => True, // булевий
    'locale' => 'locale_example', // рядок
    'is_crawler' => True, // булевий
];
try {
    $result = $apiInstance->getCommentsForUser($options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getCommentsForUser: ', $e->getMessage(), PHP_EOL;
}

addDomainConfig

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Yes

Відповідь

Повертає: AddDomainConfigResponse

Приклад

Приклад addDomainConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$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;
}

deleteDomainConfig

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
domain	string	path	Yes

Ответ

Возвращает: DeleteDomainConfigResponse

Пример

Пример deleteDomainConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$domain = 'domain_example'; // string
try {
    $result = $apiInstance->deleteDomainConfig($tenant_id, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteDomainConfig: ', $e->getMessage(), PHP_EOL;
}

getDomainConfig

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Yes
domain	string	path	Yes

Відповідь

Повертає: GetDomainConfigResponse

Приклад

Приклад getDomainConfig

Copy

<?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'; // рядок
$domain = 'domain_example'; // рядок
try {
    $result = $apiInstance->getDomainConfig($tenant_id, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDomainConfig: ', $e->getMessage(), PHP_EOL;
}

getDomainConfigs

Parameters

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да

Response

Возвращает: GetDomainConfigsResponse

Example

Пример getDomainConfigs

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
try {
    $result = $apiInstance->getDomainConfigs($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDomainConfigs: ', $e->getMessage(), PHP_EOL;
}

patchDomainConfig

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
domainToUpdate	string	path	Yes

Ответ

Возвращает: PatchDomainConfigResponse

Пример

Пример patchDomainConfig

Copy

<?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'; // строка
$domain_to_update = 'domain_to_update_example'; // строка
$patch_domain_config_params = new \FastComments\Client\Model\PatchDomainConfigParams(); // \FastComments\Client\Model\PatchDomainConfigParams
try {
    $result = $apiInstance->patchDomainConfig($tenant_id, $domain_to_update, $patch_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchDomainConfig: ', $e->getMessage(), PHP_EOL;
}

putDomainConfig

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да
domainToUpdate	string	path	Да

Ответ

Возвращает: PutDomainConfigResponse

Пример

Пример putDomainConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// // Настройка авторизации ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$domain_to_update = 'domain_to_update_example'; // string
$update_domain_config_params = new \FastComments\Client\Model\UpdateDomainConfigParams(); // \FastComments\Client\Model\UpdateDomainConfigParams
try {
    $result = $apiInstance->putDomainConfig($tenant_id, $domain_to_update, $update_domain_config_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putDomainConfig: ', $e->getMessage(), PHP_EOL;
}

createEmailTemplate

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateEmailTemplateResponse

Пример

createEmailTemplate Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$create_email_template_body = new \FastComments\Client\Model\CreateEmailTemplateBody(); // \FastComments\Client\Model\CreateEmailTemplateBody
try {
    $result = $apiInstance->createEmailTemplate($tenant_id, $create_email_template_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

deleteEmailTemplate

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deleteEmailTemplate

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteEmailTemplate($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

deleteEmailTemplateRenderError

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
id	string	path	Да
errorId	string	path	Да

Ответ

Возвращает: APIEmptyResponse

Пример

deleteEmailTemplateRenderError Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации API-ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API-ключа, если нужно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$error_id = 'error_id_example'; // string
try {
    $result = $apiInstance->deleteEmailTemplateRenderError($tenant_id, $id, $error_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteEmailTemplateRenderError: ', $e->getMessage(), PHP_EOL;
}

getEmailTemplate

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: GetEmailTemplateResponse

Пример

getEmailTemplate Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getEmailTemplate($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

getEmailTemplateDefinitions

Параметры

Имя	Тип	Место	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: GetEmailTemplateDefinitionsResponse

Пример

Пример getEmailTemplateDefinitions

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы настроить префикс (например, Bearer) для ключа API, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это необязательно, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
try {
    $result = $apiInstance->getEmailTemplateDefinitions($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplateDefinitions: ', $e->getMessage(), PHP_EOL;
}

getEmailTemplateRenderErrors

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
skip	number	query	Ні

Відповідь

Повертає: GetEmailTemplateRenderErrorsResponse

Приклад

getEmailTemplateRenderErrors Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
$skip = 3.4; // число з плаваючою крапкою
try {
    $result = $apiInstance->getEmailTemplateRenderErrors($tenant_id, $id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplateRenderErrors: ', $e->getMessage(), PHP_EOL;
}

getEmailTemplates

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
skip	number	query	No

Ответ

Возвращает: GetEmailTemplatesResponse

Пример

Пример getEmailTemplates

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$skip = 3.4; // число с плавающей точкой
try {
    $result = $apiInstance->getEmailTemplates($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEmailTemplates: ', $e->getMessage(), PHP_EOL;
}

renderEmailTemplate

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
locale	string	query	No

Відповідь

Повертає: RenderEmailTemplateResponse

Приклад

Приклад renderEmailTemplate

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$render_email_template_body = new \FastComments\Client\Model\RenderEmailTemplateBody(); // \FastComments\Client\Model\RenderEmailTemplateBody
$locale = 'locale_example'; // string
try {
    $result = $apiInstance->renderEmailTemplate($tenant_id, $render_email_template_body, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->renderEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

updateEmailTemplate

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIEmptyResponse

Приклад

updateEmailTemplate Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
$update_email_template_body = new \FastComments\Client\Model\UpdateEmailTemplateBody(); // \FastComments\Client\Model\UpdateEmailTemplateBody
try {
    $result = $apiInstance->updateEmailTemplate($tenant_id, $id, $update_email_template_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateEmailTemplate: ', $e->getMessage(), PHP_EOL;
}

getEventLog

req tenantId urlId userIdWS

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	path	Yes
urlId	string	query	Yes
userIdWS	string	query	Yes
startTime	integer	query	Yes
endTime	integer	query	No

Ответ

Возвращает: GetEventLogResponse

Пример

Пример getEventLog

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$url_id = 'url_id_example'; // строка
$user_id_ws = 'user_id_ws_example'; // строка
$start_time = 56; // целое
$end_time = 56; // целое
try {
    $result = $apiInstance->getEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getEventLog: ', $e->getMessage(), PHP_EOL;
}

getGlobalEventLog

req tenantId urlId userIdWS

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
userIdWS	string	query	Так
startTime	integer	query	Так
endTime	integer	query	Ні

Відповідь

Повертає: GetEventLogResponse

Приклад

Приклад getGlobalEventLog

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$user_id_ws = 'user_id_ws_example'; // string
$start_time = 56; // int
$end_time = 56; // int
try {
    $result = $apiInstance->getGlobalEventLog($tenant_id, $url_id, $user_id_ws, $start_time, $end_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGlobalEventLog: ', $e->getMessage(), PHP_EOL;
}

createFeedPost

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
broadcastId	string	query	Нет
isLive	boolean	query	Нет
doSpamCheck	boolean	query	Нет
skipDupCheck	boolean	query	Нет

Ответ

Возвращает: CreateFeedPostsResponse

Пример

Пример createFeedPost

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// // Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'is_live' => True, // bool
    'do_spam_check' => True, // bool
    'skip_dup_check' => True, // bool
];
try {
    $result = $apiInstance->createFeedPost($tenant_id, $create_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createFeedPost: ', $e->getMessage(), PHP_EOL;
}

createFeedPostPublic

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: CreateFeedPostResponse

Приклад

Пример createFeedPostPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$create_feed_post_params = new \FastComments\Client\Model\CreateFeedPostParams(); // \FastComments\Client\Model\CreateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->createFeedPostPublic($tenant_id, $create_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

deleteFeedPostPublic

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	путь	Да
postId	string	путь	Да
broadcastId	string	запрос	Нет
sso	string	запрос	Нет

Ответ

Возвращает: DeleteFeedPostPublicResponse

Пример

Пример deleteFeedPostPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$post_id = 'post_id_example'; // строка
$options = [
    'broadcast_id' => 'broadcast_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->deleteFeedPostPublic($tenant_id, $post_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

getFeedPosts

req tenantId afterId

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Да
afterId	string	query	Нет
limit	integer	query	Нет
tags	array	query	Нет

Ответ

Возвращает: GetFeedPostsResponse

Пример

Пример getFeedPosts

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'after_id' => 'after_id_example', // строка
    'limit' => 56, // int
    'tags' => array('tags_example'), // string[]
];
try {
    $result = $apiInstance->getFeedPosts($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getFeedPosts: ', $e->getMessage(), PHP_EOL;
}

getFeedPostsPublic

req tenantId afterId

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
afterId	string	query	Ні
limit	integer	query	Ні
tags	array	query	Ні
sso	string	query	Ні
isCrawler	boolean	query	Ні
includeUserInfo	boolean	query	Ні

Відповідь

Повертає: PublicFeedPostsResponse

Приклад

getFeedPostsPublic Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати кастомний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'after_id' => 'after_id_example', // string
    'limit' => 56, // int
    'tags' => array('tags_example'), // string[]
    'sso' => 'sso_example', // string
    'is_crawler' => True, // bool
    'include_user_info' => True, // bool
];
try {
    $result = $apiInstance->getFeedPostsPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getFeedPostsPublic: ', $e->getMessage(), PHP_EOL;
}

getFeedPostsStats

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
postIds	array	query	Так
sso	string	query	Ні

Відповідь

Повертає: FeedPostsStatsResponse

Приклад

Приклад getFeedPostsStats

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$post_ids = array('post_ids_example'); // рядок[]
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->getFeedPostsStats($tenant_id, $post_ids, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getFeedPostsStats: ', $e->getMessage(), PHP_EOL;
}

getUserReactsPublic

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	path	Так
postIds	array	query	Ні
sso	string	query	Ні

Відповідь

Повертає: UserReactsResponse

Приклад

Приклад getUserReactsPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням використовується `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'post_ids' => array('post_ids_example'), // string[]
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getUserReactsPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserReactsPublic: ', $e->getMessage(), PHP_EOL;
}

reactFeedPostPublic

Параметри

Name	Type	Location	Required
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: ReactFeedPostResponse

Приклад

reactFeedPostPublic Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням використовується `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$post_id = 'post_id_example'; // string
$react_body_params = new \FastComments\Client\Model\ReactBodyParams(); // \FastComments\Client\Model\ReactBodyParams
$options = [
    'is_undo' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->reactFeedPostPublic($tenant_id, $post_id, $react_body_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->reactFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

updateFeedPost

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: APIEmptyResponse

Пример

Пример updateFeedPost

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API-ключа, если необходимо)
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте свой клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$id = 'id_example'; // строка
$feed_post = new \FastComments\Client\Model\FeedPost(); // \FastComments\Client\Model\FeedPost
try {
    $result = $apiInstance->updateFeedPost($tenant_id, $id, $feed_post);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateFeedPost: ', $e->getMessage(), PHP_EOL;
}

updateFeedPostPublic

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
postId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: CreateFeedPostResponse

Приклад

updateFeedPostPublic Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$post_id = 'post_id_example'; // string
$update_feed_post_params = new \FastComments\Client\Model\UpdateFeedPostParams(); // \FastComments\Client\Model\UpdateFeedPostParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->updateFeedPostPublic($tenant_id, $post_id, $update_feed_post_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateFeedPostPublic: ', $e->getMessage(), PHP_EOL;
}

flagCommentPublic

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	path	Да
isFlagged	boolean	query	Да
sso	string	query	Нет

Ответ

Возвращает: APIEmptyResponse

Пример

flagCommentPublic Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$is_flagged = True; // логический
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->flagCommentPublic($tenant_id, $comment_id, $is_flagged, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->flagCommentPublic: ', $e->getMessage(), PHP_EOL;
}

getGifLarge

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	path	Yes
largeInternalURLSanitized	string	query	Yes

Ответ

Возвращает: GifGetLargeResponse

Пример

Пример getGifLarge

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$large_internal_url_sanitized = 'large_internal_url_sanitized_example'; // строка
try {
    $result = $apiInstance->getGifLarge($tenant_id, $large_internal_url_sanitized);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifLarge: ', $e->getMessage(), PHP_EOL;
}

getGifsSearch

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	path	Yes
search	string	query	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

Відповідь

Повертає: GetGifsSearchResponse

Приклад

Приклад getGifsSearch

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$search = 'search_example'; // string
$options = [
    'locale' => 'locale_example', // string
    'rating' => 'rating_example', // string
    'page' => 3.4, // float
];
try {
    $result = $apiInstance->getGifsSearch($tenant_id, $search, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifsSearch: ', $e->getMessage(), PHP_EOL;
}

getGifsTrending

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Так
locale	string	query	Ні
rating	string	query	Ні
page	number	query	Ні

Відповідь

Повертає: GetGifsTrendingResponse

Приклад

Приклад getGifsTrending

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$options = [
    'locale' => 'locale_example', // рядок
    'rating' => 'rating_example', // рядок
    'page' => 3.4, // float
];
try {
    $result = $apiInstance->getGifsTrending($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getGifsTrending: ', $e->getMessage(), PHP_EOL;
}

addHashTag

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateHashTagResponse

Пример

addHashTag Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$create_hash_tag_body = new \FastComments\Client\Model\CreateHashTagBody(); // \FastComments\Client\Model\CreateHashTagBody
try {
    $result = $apiInstance->addHashTag($tenant_id, $create_hash_tag_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addHashTag: ', $e->getMessage(), PHP_EOL;
}

addHashTagsBulk

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: BulkCreateHashTagsResponse

Пример

addHashTagsBulk Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$bulk_create_hash_tags_body = new \FastComments\Client\Model\BulkCreateHashTagsBody(); // \FastComments\Client\Model\BulkCreateHashTagsBody
try {
    $result = $apiInstance->addHashTagsBulk($tenant_id, $bulk_create_hash_tags_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addHashTagsBulk: ', $e->getMessage(), PHP_EOL;
}

deleteHashTag

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так
tag	string	path	Так

Відповідь

Returns: APIEmptyResponse

Приклад

Приклад deleteHashTag

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$tag = 'tag_example'; // string
$delete_hash_tag_request_body = new \FastComments\Client\Model\DeleteHashTagRequestBody(); // \FastComments\Client\Model\DeleteHashTagRequestBody
try {
    $result = $apiInstance->deleteHashTag($tenant_id, $tag, $delete_hash_tag_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteHashTag: ', $e->getMessage(), PHP_EOL;
}

getHashTags

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
page	number	query	Ні

Відповідь

Повертає: GetHashTagsResponse

Приклад

Приклад getHashTags

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$page = 3.4; // число з плаваючою крапкою
try {
    $result = $apiInstance->getHashTags($tenant_id, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getHashTags: ', $e->getMessage(), PHP_EOL;
}

patchHashTag

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
tag	string	path	Да

Ответ

Возвращает: UpdateHashTagResponse

Пример

patchHashTag Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации API‑ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментировать ниже, чтобы установить префикс (например, Bearer) для API‑ключа, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$tag = 'tag_example'; // string
$update_hash_tag_body = new \FastComments\Client\Model\UpdateHashTagBody(); // \FastComments\Client\Model\UpdateHashTagBody
try {
    $result = $apiInstance->patchHashTag($tenant_id, $tag, $update_hash_tag_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchHashTag: ', $e->getMessage(), PHP_EOL;
}

deleteModerationVote

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: VoteDeleteResponse

Приклад

Приклад deleteModerationVote

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати кастомний http-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$vote_id = 'vote_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->deleteModerationVote($tenant_id, $comment_id, $vote_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->deleteModerationVote: ', $e->getMessage(), PHP_EOL;
}

getApiComments

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
page	number	query	Нет
count	number	query	Нет
text-search	string	query	Нет
byIPFromComment	string	query	Нет
filters	string	query	Нет
searchFilters	string	query	Нет
sorts	string	query	Нет
demo	boolean	query	Нет
sso	string	query	Нет

Ответ

Returns: ModerationAPIGetCommentsResponse

Пример

getApiComments Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'page' => 3.4, // число с плавающей точкой
    'count' => 3.4, // число с плавающей точкой
    'text_search' => 'text_search_example', // строка
    'by_ip_from_comment' => 'by_ip_from_comment_example', // строка
    'filters' => 'filters_example', // строка
    'search_filters' => 'search_filters_example', // строка
    'sorts' => 'sorts_example', // строка
    'demo' => True, // логическое значение
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getApiComments($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiComments: ', $e->getMessage(), PHP_EOL;
}

getApiExportStatus

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
batchJobId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: ModerationExportStatusResponse

Пример

Пример getApiExportStatus

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'batch_job_id' => 'batch_job_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getApiExportStatus($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiExportStatus: ', $e->getMessage(), PHP_EOL;
}

getApiIds

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
afterId	string	query	No
demo	boolean	query	No
sso	string	query	No

Ответ

Возвращает: ModerationAPIGetCommentIdsResponse

Пример

Пример getApiIds

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'text_search' => 'text_search_example', // строка
    'by_ip_from_comment' => 'by_ip_from_comment_example', // строка
    'filters' => 'filters_example', // строка
    'search_filters' => 'search_filters_example', // строка
    'after_id' => 'after_id_example', // строка
    'demo' => True, // булево
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getApiIds($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getApiIds: ', $e->getMessage(), PHP_EOL;
}

getBanUsersFromComment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetBannedUsersFromCommentResponse

Приклад

Приклад getBanUsersFromComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$comment_id = 'comment_id_example'; // рядок
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->getBanUsersFromComment($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getBanUsersFromComment: ', $e->getMessage(), PHP_EOL;
}

getCommentBanStatus

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentBanStatusResponse

Приклад

Приклад getCommentBanStatus

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$comment_id = 'comment_id_example'; // рядок
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->getCommentBanStatus($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCommentBanStatus: ', $e->getMessage(), PHP_EOL;
}

getCommentChildren

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

getCommentChildren Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getCommentChildren($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCommentChildren: ', $e->getMessage(), PHP_EOL;
}

getCount

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

Ответ

Возвращает: ModerationAPICountCommentsResponse

Пример

Пример getCount

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать собственный HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filter' => 'filter_example', // string
    'search_filters' => 'search_filters_example', // string
    'demo' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}

getCounts

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: GetBannedUsersCountResponse

Приклад

Приклад getCounts

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власного HTTP‑клієнта, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getCounts($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getCounts: ', $e->getMessage(), PHP_EOL;
}

getLogs

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIGetLogsResponse

Приклад

Приклад getLogs

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати кастомний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getLogs($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getLogs: ', $e->getMessage(), PHP_EOL;
}

getManualBadges

Параметри

Назва	Тип	Location	Обов'язково	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetTenantManualBadgesResponse

Приклад

Приклад getManualBadges

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний http‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це опціонально, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getManualBadges($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getManualBadges: ', $e->getMessage(), PHP_EOL;
}

getManualBadgesForUser

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
badgesUserId	string	query	Нет
commentId	string	query	Нет
sso	string	query	Нет

Ответ

Returns: GetUserManualBadgesResponse

Пример

Пример getManualBadgesForUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'badges_user_id' => 'badges_user_id_example', // строка
    'comment_id' => 'comment_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getManualBadgesForUser($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getManualBadgesForUser: ', $e->getMessage(), PHP_EOL;
}

getModerationComment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ModerationAPICommentResponse

Приклад

Приклад getModerationComment

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$options = [
    'include_email' => True, // булево
    'include_ip' => True, // булево
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getModerationComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getModerationComment: ', $e->getMessage(), PHP_EOL;
}

getModerationCommentText

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentTextResponse

Приклад

Приклад getModerationCommentText

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо хочете використати власний HTTP-клієнт, передайте ваш клієнт, що реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getModerationCommentText($tenant_id, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getModerationCommentText: ', $e->getMessage(), PHP_EOL;
}

getPreBanSummary

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
commentId	string	path	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Ответ

Возвращает: PreBanSummary

Пример

Пример getPreBanSummary

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$options = [
    'include_by_user_id_and_email' => True, // логическое
    'include_by_ip' => True, // логическое
    'include_by_email_domain' => True, // логическое
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getPreBanSummary($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
}

getSearchCommentsSummary

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
value	string	query	No
filters	string	query	No
searchFilters	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationCommentSearchResponse

Приклад

Приклад getSearchCommentsSummary

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchCommentsSummary($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchCommentsSummary: ', $e->getMessage(), PHP_EOL;
}

getSearchPages

Parameters

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

Response

Возвращает: ModerationPageSearchResponse

Пример

Пример getSearchPages

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchPages($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchPages: ', $e->getMessage(), PHP_EOL;
}

getSearchSites

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationSiteSearchResponse

Приклад

Приклад getSearchSites

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchSites($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchSites: ', $e->getMessage(), PHP_EOL;
}

getSearchSuggest

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
text-search	string	query	No
sso	string	query	No

Ответ

Возвращает: ModerationSuggestResponse

Пример

Пример getSearchSuggest

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchSuggest($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchSuggest: ', $e->getMessage(), PHP_EOL;
}

getSearchUsers

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationUserSearchResponse

Приклад

getSearchUsers Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати кастомний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це опціонально, за замовчуванням буде використаний `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'value' => 'value_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->getSearchUsers($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getSearchUsers: ', $e->getMessage(), PHP_EOL;
}

getTrustFactor

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

Ответ

Возвращает: GetUserTrustFactorResponse

Пример

getTrustFactor Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский http‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'user_id' => 'user_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getTrustFactor($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getTrustFactor: ', $e->getMessage(), PHP_EOL;
}

getUserBanPreference

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Yes
sso	string	query	No

Ответ

Возвращает: APIModerateGetUserBanPreferencesResponse

Пример

Пример getUserBanPreference

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->getUserBanPreference($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getUserBanPreference: ', $e->getMessage(), PHP_EOL;
}

getUserInternalProfile

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: GetUserInternalProfileResponse

Пример

Пример getUserInternalProfile

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'comment_id' => 'comment_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getUserInternalProfile($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getUserInternalProfile: ', $e->getMessage(), PHP_EOL;
}

postAdjustCommentVotes

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: AdjustVotesResponse

Приклад

Приклад postAdjustCommentVotes

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$adjust_comment_votes_params = new \FastComments\Client\Model\AdjustCommentVotesParams(); // \FastComments\Client\Model\AdjustCommentVotesParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postAdjustCommentVotes: ', $e->getMessage(), PHP_EOL;
}

postApiExport

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationExportResponse

Приклад

postApiExport Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати кастомний HTTP-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$options = [
    'text_search' => 'text_search_example', // рядок
    'by_ip_from_comment' => 'by_ip_from_comment_example', // рядок
    'filters' => 'filters_example', // рядок
    'search_filters' => 'search_filters_example', // рядок
    'sorts' => 'sorts_example', // рядок
    'sso' => 'sso_example', // рядок
];
try {
    $result = $apiInstance->postApiExport($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postApiExport: ', $e->getMessage(), PHP_EOL;
}

postBanUserFromComment

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Ответ

Возвращает: BanUserFromCommentResult

Пример

postBanUserFromComment Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'ban_email' => True, // bool
    'ban_email_domain' => True, // bool
    'ban_ip' => True, // bool
    'delete_all_users_comments' => True, // bool
    'banned_until' => 'banned_until_example', // string
    'is_shadow_ban' => True, // bool
    'update_id' => 'update_id_example', // string
    'ban_reason' => 'ban_reason_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postBanUserFromComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBanUserFromComment: ', $e->getMessage(), PHP_EOL;
}

postBanUserUndo

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

postBanUserUndo Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->postBanUserUndo($tenant_id, $ban_user_undo_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBanUserUndo: ', $e->getMessage(), PHP_EOL;
}

postBulkPreBanSummary

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Відповідь

Повертає: BulkPreBanSummary

Приклад

postBulkPreBanSummary Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете использовать кастомный HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використаний `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$bulk_pre_ban_params = new \FastComments\Client\Model\BulkPreBanParams(); // \FastComments\Client\Model\BulkPreBanParams
$options = [
    'include_by_user_id_and_email' => True, // bool
    'include_by_ip' => True, // bool
    'include_by_email_domain' => True, // bool
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postBulkPreBanSummary: ', $e->getMessage(), PHP_EOL;
}

postCommentsByIds

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
sso	string	query	Нет

Ответ

Возвращает: ModerationAPIChildCommentsResponse

Пример

Пример postCommentsByIds

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный http‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->postCommentsByIds($tenant_id, $comments_by_ids_params, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postCommentsByIds: ', $e->getMessage(), PHP_EOL;
}

postFlagComment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	запит	Так
commentId	string	шлях	Так
broadcastId	string	запит	Ні
sso	string	запит	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

postFlagComment Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postFlagComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postFlagComment: ', $e->getMessage(), PHP_EOL;
}

postRemoveComment

Parameters

Name	Type	Location	Required
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Response

Повертає: PostRemoveCommentApiResponse

Приклад

postRemoveComment Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postRemoveComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postRemoveComment: ', $e->getMessage(), PHP_EOL;
}

postRestoreDeletedComment

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Ответ

Возвращает: APIEmptyResponse

Пример

postRestoreDeletedComment Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный http клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postRestoreDeletedComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postRestoreDeletedComment: ', $e->getMessage(), PHP_EOL;
}

postSetCommentApprovalStatus

Параметри

Ім’я	Тип	Місцезнаходження	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: SetCommentApprovedResponse

Приклад

postSetCommentApprovalStatus Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'approved' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postSetCommentApprovalStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentApprovalStatus: ', $e->getMessage(), PHP_EOL;
}

postSetCommentReviewStatus

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
commentId	string	path	Так
reviewed	boolean	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

postSetCommentReviewStatus Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$comment_id = 'comment_id_example'; // рядок
$options = [
    'reviewed' => True, // логічний
    'broadcast_id' => 'broadcast_id_example', // рядок
    'sso' => 'sso_example', // рядок
];
try {
    $result = $apiInstance->postSetCommentReviewStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentReviewStatus: ', $e->getMessage(), PHP_EOL;
}

postSetCommentSpamStatus

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	path	Да
spam	boolean	query	Нет
permNotSpam	boolean	query	Нет
broadcastId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: APIEmptyResponse

Пример

postSetCommentSpamStatus Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'spam' => True, // bool
    'perm_not_spam' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postSetCommentSpamStatus($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentSpamStatus: ', $e->getMessage(), PHP_EOL;
}

postSetCommentText

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	path	Да
broadcastId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: SetCommentTextResponse

Пример

Пример postSetCommentText

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postSetCommentText: ', $e->getMessage(), PHP_EOL;
}

postUnFlagComment

Parameters

Name	Type	Location	Required
tenantId	string	query	Да
commentId	string	path	Да
broadcastId	string	query	Нет
sso	string	query	Нет

Response

Возвращает: APIEmptyResponse

Пример

postUnFlagComment Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->postUnFlagComment($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postUnFlagComment: ', $e->getMessage(), PHP_EOL;
}

postVote

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	path	Да
direction	string	query	Нет
broadcastId	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: VoteResponse

Пример

postVote Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$comment_id = 'comment_id_example'; // строка
$options = [
    'direction' => 'direction_example', // строка
    'broadcast_id' => 'broadcast_id_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->postVote($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->postVote: ', $e->getMessage(), PHP_EOL;
}

putAwardBadge

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: AwardUserBadgeResponse

Приклад

putAwardBadge Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використовувати власний http-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$badge_id = 'badge_id_example'; // рядок
$options = [
    'user_id' => 'user_id_example', // рядок
    'comment_id' => 'comment_id_example', // рядок
    'broadcast_id' => 'broadcast_id_example', // рядок
    'sso' => 'sso_example', // рядок
];
try {
    $result = $apiInstance->putAwardBadge($tenant_id, $badge_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
}

putCloseThread

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Да
urlId	string	query	Да
sso	string	query	Нет

Ответ

Возвращает: APIEmptyResponse

Пример

Пример putCloseThread

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->putCloseThread($tenant_id, $url_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putCloseThread: ', $e->getMessage(), PHP_EOL;
}

putRemoveBadge

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: RemoveUserBadgeResponse

Приклад

putRemoveBadge Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// $apiInstance = new FastComments\Client\Api\ModerationApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$badge_id = 'badge_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'comment_id' => 'comment_id_example', // string
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];
try {
    $result = $apiInstance->putRemoveBadge($tenant_id, $badge_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putRemoveBadge: ', $e->getMessage(), PHP_EOL;
}

putReopenThread

Parameters

Name	Type	Location	Required
tenantId	string	query	Да
urlId	string	query	Да
sso	string	query	Нет

Response

Возвращает: APIEmptyResponse

Example

Пример putReopenThread

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Инициализируем объект API
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте свой клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->putReopenThread($tenant_id, $url_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putReopenThread: ', $e->getMessage(), PHP_EOL;
}

setTrustFactor

Parameters

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
userId	string	query	Нет
trustFactor	string	query	Нет
sso	string	query	Нет

Ответ

Возвращает: SetUserTrustFactorResponse

Пример

Пример setTrustFactor

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'user_id' => 'user_id_example', // строка
    'trust_factor' => 'trust_factor_example', // строка
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->setTrustFactor($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->setTrustFactor: ', $e->getMessage(), PHP_EOL;
}

createModerator

Параметри

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

Відповідь

Повертає: CreateModeratorResponse

Приклад

Приклад createModerator

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Налаштуйте авторизацію API ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API ключа, за потреби
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Якщо ви хочете використати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Це необов'язково, `GuzzleHttp\Client` буде використано за замовчуванням.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_moderator_body = new \FastComments\Client\Model\CreateModeratorBody(); // \FastComments\Client\Model\CreateModeratorBody
try {
    $result = $apiInstance->createModerator($tenant_id, $create_moderator_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createModerator: ', $e->getMessage(), PHP_EOL;
}

deleteModerator

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
id	string	path	Да
sendEmail	string	query	Нет

Ответ

Возвращает: APIEmptyResponse

Пример

Пример deleteModerator

Copy

<?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'; // строка
$id = 'id_example'; // строка
$send_email = 'send_email_example'; // строка
try {
    $result = $apiInstance->deleteModerator($tenant_id, $id, $send_email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteModerator: ', $e->getMessage(), PHP_EOL;
}

getModerator

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: GetModeratorResponse

Приклад

Приклад getModerator

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->getModerator($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getModerator: ', $e->getMessage(), PHP_EOL;
}

getModerators

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
skip	number	query	Нет

Ответ

Returns: GetModeratorsResponse

Пример

Пример getModerators

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключом: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$skip = 3.4; // float
try {
    $result = $apiInstance->getModerators($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getModerators: ', $e->getMessage(), PHP_EOL;
}

sendInvite

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
id	string	path	Yes
fromName	string	query	Yes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад sendInvite

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$from_name = 'from_name_example'; // string
try {
    $result = $apiInstance->sendInvite($tenant_id, $id, $from_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->sendInvite: ', $e->getMessage(), PHP_EOL;
}

updateModerator

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIEmptyResponse

Пример

Пример updateModerator

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$update_moderator_body = new \FastComments\Client\Model\UpdateModeratorBody(); // \FastComments\Client\Model\UpdateModeratorBody
try {
    $result = $apiInstance->updateModerator($tenant_id, $id, $update_moderator_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateModerator: ', $e->getMessage(), PHP_EOL;
}

deleteNotificationCount

Параметры

Имя	Тип	Location	Required	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: APIEmptyResponse

Пример

Пример deleteNotificationCount

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->deleteNotificationCount($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteNotificationCount: ', $e->getMessage(), PHP_EOL;
}

getCachedNotificationCount

Параметри

Назва	Тип	Розташування	Обовʼязковий	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: GetCachedNotificationCountResponse

Приклад

Приклад getCachedNotificationCount

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію за допомогою API‑ключа: api_key
// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для API‑ключа, якщо потрібно
// Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
// Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, `GuzzleHttp\Client` буде використано за замовчуванням.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getCachedNotificationCount($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getCachedNotificationCount: ', $e->getMessage(), PHP_EOL;
}

getNotificationCount

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
userId	string	query	No
urlId	string	query	No
fromCommentId	string	query	No
viewed	boolean	query	No
type	string	query	No

Ответ

Возвращает: GetNotificationCountResponse

Пример

getNotificationCount Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$options = [
    'user_id' => 'user_id_example', // строка
    'url_id' => 'url_id_example', // строка
    'from_comment_id' => 'from_comment_id_example', // строка
    'viewed' => True, // логическое
    'type' => 'type_example', // строка
];
try {
    $result = $apiInstance->getNotificationCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNotificationCount: ', $e->getMessage(), PHP_EOL;
}

getNotifications

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
userId	string	query	Ні
urlId	string	query	Ні
fromCommentId	string	query	Ні
viewed	boolean	query	Ні
type	string	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetNotificationsResponse

Приклад

Пример getNotifications

Copy

<?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'; // строка
$options = [
    'user_id' => 'user_id_example', // строка
    'url_id' => 'url_id_example', // строка
    'from_comment_id' => 'from_comment_id_example', // строка
    'viewed' => True, // булево
    'type' => 'type_example', // строка
    'skip' => 3.4, // число с плавающей точкой
];
try {
    $result = $apiInstance->getNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNotifications: ', $e->getMessage(), PHP_EOL;
}

updateNotification

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Ответ

Возвращает: APIEmptyResponse

Пример

updateNotification Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$update_notification_body = new \FastComments\Client\Model\UpdateNotificationBody(); // \FastComments\Client\Model\UpdateNotificationBody
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->updateNotification($tenant_id, $id, $update_notification_body, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateNotification: ', $e->getMessage(), PHP_EOL;
}

createV1PageReact

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Yes
urlId	string	query	Yes
title	string	query	No

Ответ

Возвращает: CreateV1PageReact

Пример

Пример createV1PageReact

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$url_id = 'url_id_example'; // строка
$title = 'title_example'; // строка
try {
    $result = $apiInstance->createV1PageReact($tenant_id, $url_id, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createV1PageReact: ', $e->getMessage(), PHP_EOL;
}

createV2PageReact

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes
title	string	query	No

Відповідь

Повертає: CreateV1PageReact

Приклад

Приклад createV2PageReact

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$id = 'id_example'; // string
$title = 'title_example'; // string
try {
    $result = $apiInstance->createV2PageReact($tenant_id, $url_id, $id, $title);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->createV2PageReact: ', $e->getMessage(), PHP_EOL;
}

deleteV1PageReact

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	path	Yes
urlId	string	query	Yes

Відповідь

Returns: CreateV1PageReact

Приклад

Приклад deleteV1PageReact

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$url_id = 'url_id_example'; // рядок
try {
    $result = $apiInstance->deleteV1PageReact($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteV1PageReact: ', $e->getMessage(), PHP_EOL;
}

deleteV2PageReact

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Yes
urlId	string	query	Yes
id	string	query	Yes

Ответ

Возвращает: CreateV1PageReact

Пример

Пример deleteV2PageReact

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$url_id = 'url_id_example'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->deleteV2PageReact($tenant_id, $url_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->deleteV2PageReact: ', $e->getMessage(), PHP_EOL;
}

getV1PageLikes

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	path	Yes
urlId	string	query	Yes

Відповідь

Повертає: GetV1PageLikes

Приклад

getV1PageLikes Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати власний HTTP-клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getV1PageLikes($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV1PageLikes: ', $e->getMessage(), PHP_EOL;
}

getV2PageReacts

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	path	Yes
urlId	string	query	Yes

Відповідь

Повертає: GetV2PageReacts

Приклад

getV2PageReacts Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getV2PageReacts($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV2PageReacts: ', $e->getMessage(), PHP_EOL;
}

getV2PageReactUsers

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Да
urlId	string	query	Да
id	string	query	Да

Ответ

Возвращает: GetV2PageReactUsersResponse

Пример

getV2PageReactUsers Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если хотите использовать пользовательский http‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getV2PageReactUsers($tenant_id, $url_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getV2PageReactUsers: ', $e->getMessage(), PHP_EOL;
}

addPage

Parameters

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

Response

Повертає: AddPageAPIResponse

Example

addPage Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключем API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_api_page_data = new \FastComments\Client\Model\CreateAPIPageData(); // \FastComments\Client\Model\CreateAPIPageData
try {
    $result = $apiInstance->addPage($tenant_id, $create_api_page_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addPage: ', $e->getMessage(), PHP_EOL;
}

deletePage

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: DeletePageAPIResponse

Пример

Пример deletePage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации API-ключом: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментировать ниже, чтобы установить префикс (например, Bearer) для API-ключа, если требуется
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если хотите использовать пользовательский HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deletePage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deletePage: ', $e->getMessage(), PHP_EOL;
}

getOfflineUsers

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

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	path	Yes
urlId	string	query	Yes	Идентификатор URL страницы (очищенный на стороне сервера).
afterName	string	query	No	Курсор: передайте nextAfterName из предыдущего ответа.
afterUserId	string	query	No	Тай-брейкер курсора: передайте nextAfterUserId из предыдущего ответа. Требуется, когда установлен afterName, чтобы не терять записи с одинаковыми именами.

Response

Returns: PageUsersOfflineResponse

Пример

Пример getOfflineUsers

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // Это необязательно, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string | Идентификатор URL страницы (очищенный на стороне сервера).
$options = [
    'after_name' => 'after_name_example', // string | Курсор: передайте nextAfterName из предыдущего ответа.
    'after_user_id' => 'after_user_id_example', // string | Тай-брейкер курсора: передайте nextAfterUserId из предыдущего ответа. Требуется, когда установлен afterName, чтобы не терять записи с одинаковыми именами.
];
try {
    $result = $apiInstance->getOfflineUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getOfflineUsers: ', $e->getMessage(), PHP_EOL;
}

getOnlineUsers

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Текущие онлайн‑просмотры страницы: пользователи, чья websocket‑сессия в данный момент подписана на страницу.

Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Возвращает anonCount + totalCount (подписчики на уровне комнаты, включая анонимных зрителей, которые не перечисляются).

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	path	Yes
urlId	string	query	Yes	Идентификатор URL страницы (очищенный на сервере).
afterName	string	query	No	Курсор: передайте nextAfterName из предыдущего ответа.
afterUserId	string	query	No	Тайбрейкер курсора: передайте nextAfterUserId из предыдущего ответа. Требуется, когда установлен afterName, чтобы записи с одинаковыми именами не отбрасывались.

Ответ

Возвращает: PageUsersOnlineResponse

Пример

Пример getOnlineUsers

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный http‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string | Идентификатор URL страницы (очищенный на сервере).
$options = [
    'after_name' => 'after_name_example', // string | Курсор: передайте nextAfterName из предыдущего ответа.
    'after_user_id' => 'after_user_id_example', // string | Тайбрейкер курсора: передайте nextAfterUserId из предыдущего ответа. Требуется, когда установлен afterName, чтобы записи с одинаковыми именами не отбрасывались.
];
try {
    $result = $apiInstance->getOnlineUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getOnlineUsers: ', $e->getMessage(), PHP_EOL;
}

getPageByURLId

Параметри

Ім'я	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
urlId	string	query	Так

Відповідь

Повертає: GetPageByURLIdAPIResponse

Приклад

Пример getPageByURLId

Copy

<?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'; // рядок
$url_id = 'url_id_example'; // рядок
try {
    $result = $apiInstance->getPageByURLId($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPageByURLId: ', $e->getMessage(), PHP_EOL;
}

getPages

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes

Ответ

Возвращает: GetPagesAPIResponse

Пример

Пример getPages

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации с помощью API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
try {
    $result = $apiInstance->getPages($tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPages: ', $e->getMessage(), PHP_EOL;
}

getPagesPublic

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

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
cursor	string	query	No	Непрозорий курсор пагінації, що повертається як `nextCursor` зі попереднього запиту. Прив’язаний до того ж `sortBy`.
limit	integer	query	No	1..200, за замовчуванням 50
q	string	query	No	Необов’язковий нечутливий до регістру фільтр за префіксом назви.
sortBy	string	query	No	Порядок сортування. `updatedAt` (за замовчуванням, новіші спочатку), `commentCount` (спочатку з найбільшою кількістю коментарів) або `title` (за алфавітом).
hasComments	boolean	query	No	Якщо true, повернути лише сторінки, які мають щонайменше один коментар.

Response

Returns: GetPublicPagesResponse

Example

Приклад getPagesPublic

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням використовується `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$options = [
    'cursor' => 'cursor_example', // string | Непрозорий курсор пагінації, що повертається як `nextCursor` зі попереднього запиту. Прив’язаний до того ж `sortBy`.
    'limit' => 56, // int | 1..200, за замовчуванням 50
    'q' => 'q_example', // string | Необов’язковий нечутливий до регістру фільтр за префіксом назви.
    'sort_by' => new \FastComments\Client\Model\\FastComments\Client\Model\PagesSortBy(), // \FastComments\Client\Model\PagesSortBy | Порядок сортування. `updatedAt` (за замовчуванням, новіші спочатку), `commentCount` (спочатку з найбільшою кількістю коментарів) або `title` (за алфавітом).
    'has_comments' => True, // bool | Якщо true, повернути лише сторінки, які мають щонайменше один коментар.
];
try {
    $result = $apiInstance->getPagesPublic($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getPagesPublic: ', $e->getMessage(), PHP_EOL;
}

getUsersInfo

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

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
ids	string	query	Yes	UserIds, розділені комами.

Response

Returns: PageUsersInfoResponse

Example

getUsersInfo Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати кастомний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$ids = 'ids_example'; // string | UserIds, розділені комами.
try {
    $result = $apiInstance->getUsersInfo($tenant_id, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUsersInfo: ', $e->getMessage(), PHP_EOL;
}

patchPage

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Returns: PatchPageAPIResponse

Приклад

Приклад patchPage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
$update_api_page_data = new \FastComments\Client\Model\UpdateAPIPageData(); // \FastComments\Client\Model\UpdateAPIPageData
try {
    $result = $apiInstance->patchPage($tenant_id, $id, $update_api_page_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchPage: ', $e->getMessage(), PHP_EOL;
}

deletePendingWebhookEvent

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIEmptyResponse

Приклад

deletePendingWebhookEvent Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->deletePendingWebhookEvent($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deletePendingWebhookEvent: ', $e->getMessage(), PHP_EOL;
}

getPendingWebhookEventCount

Parameters

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
commentId	string	query	Нет
externalId	string	query	Нет
eventType	string	query	Нет
type	string	query	Нет
domain	string	query	Нет
attemptCountGT	number	query	Нет

Response

Возвращает: GetPendingWebhookEventCountResponse

Example

Пример getPendingWebhookEventCount

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройте авторизацию API-ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API-ключа, если необходимо
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, `GuzzleHttp\Client` будет использоваться по умолчанию.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'comment_id' => 'comment_id_example', // строка
    'external_id' => 'external_id_example', // строка
    'event_type' => 'event_type_example', // строка
    'type' => 'type_example', // строка
    'domain' => 'domain_example', // строка
    'attempt_count_gt' => 3.4, // число с плавающей запятой
];
try {
    $result = $apiInstance->getPendingWebhookEventCount($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPendingWebhookEventCount: ', $e->getMessage(), PHP_EOL;
}

getPendingWebhookEvents

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	query	Ні
externalId	string	query	Ні
eventType	string	query	Ні
type	string	query	Ні
domain	string	query	Ні
attemptCountGT	number	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetPendingWebhookEventsResponse

Приклад

Приклад getPendingWebhookEvents

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// // Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$options = [
    'comment_id' => 'comment_id_example', // рядок
    'external_id' => 'external_id_example', // рядок
    'event_type' => 'event_type_example', // рядок
    'type' => 'type_example', // рядок
    'domain' => 'domain_example', // рядок
    'attempt_count_gt' => 3.4, // число з плаваючою крапкою
    'skip' => 3.4, // число з плаваючою крапкою
];
try {
    $result = $apiInstance->getPendingWebhookEvents($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPendingWebhookEvents: ', $e->getMessage(), PHP_EOL;
}

createQuestionConfig

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateQuestionConfigResponse

Пример

createQuestionConfig Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$create_question_config_body = new \FastComments\Client\Model\CreateQuestionConfigBody(); // \FastComments\Client\Model\CreateQuestionConfigBody
try {
    $result = $apiInstance->createQuestionConfig($tenant_id, $create_question_config_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

deleteQuestionConfig

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIEmptyResponse

Пример

Пример deleteQuestionConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации API-ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API-ключа, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->deleteQuestionConfig($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

getQuestionConfig

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: GetQuestionConfigResponse

Пример

Пример getQuestionConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настроить авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getQuestionConfig($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

getQuestionConfigs

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
skip	number	query	No

Ответ

Возвращает: GetQuestionConfigsResponse

Пример

Пример getQuestionConfigs

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$skip = 3.4; // число с плавающей запятой
try {
    $result = $apiInstance->getQuestionConfigs($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionConfigs: ', $e->getMessage(), PHP_EOL;
}

updateQuestionConfig

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIEmptyResponse

Пример

Пример updateQuestionConfig

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$update_question_config_body = new \FastComments\Client\Model\UpdateQuestionConfigBody(); // \FastComments\Client\Model\UpdateQuestionConfigBody
try {
    $result = $apiInstance->updateQuestionConfig($tenant_id, $id, $update_question_config_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateQuestionConfig: ', $e->getMessage(), PHP_EOL;
}

createQuestionResult

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateQuestionResultResponse

Пример

createQuestionResult Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_question_result_body = new \FastComments\Client\Model\CreateQuestionResultBody(); // \FastComments\Client\Model\CreateQuestionResultBody
try {
    $result = $apiInstance->createQuestionResult($tenant_id, $create_question_result_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createQuestionResult: ', $e->getMessage(), PHP_EOL;
}

deleteQuestionResult

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

deleteQuestionResult Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->deleteQuestionResult($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteQuestionResult: ', $e->getMessage(), PHP_EOL;
}

getQuestionResult

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: GetQuestionResultResponse

Пример

Пример getQuestionResult

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию с помощью API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->getQuestionResult($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionResult: ', $e->getMessage(), PHP_EOL;
}

getQuestionResults

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
urlId	string	query	No
userId	string	query	No
startDate	string	query	No
questionId	string	query	No
questionIds	string	query	No
skip	number	query	No

Ответ

Возвращает: GetQuestionResultsResponse

Пример

getQuestionResults Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'url_id' => 'url_id_example', // string
    'user_id' => 'user_id_example', // string
    'start_date' => 'start_date_example', // string
    'question_id' => 'question_id_example', // string
    'question_ids' => 'question_ids_example', // string
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getQuestionResults: ', $e->getMessage(), PHP_EOL;
}

updateQuestionResult

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад updateQuestionResult

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$update_question_result_body = new \FastComments\Client\Model\UpdateQuestionResultBody(); // \FastComments\Client\Model\UpdateQuestionResultBody
try {
    $result = $apiInstance->updateQuestionResult($tenant_id, $id, $update_question_result_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateQuestionResult: ', $e->getMessage(), PHP_EOL;
}

aggregateQuestionResults

Параметри

Ім'я	Тип	Місцезнаходження	Обов'язково
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
timeBucket	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No

Відповідь

Возвращает: AggregateQuestionResultsResponse

Приклад

aggregateQuestionResults Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$options = [
    'question_id' => 'question_id_example', // string
    'question_ids' => array('question_ids_example'), // string[]
    'url_id' => 'url_id_example', // string
    'time_bucket' => new \FastComments\Client\Model\\FastComments\Client\Model\AggregateTimeBucket(), // \FastComments\Client\Model\AggregateTimeBucket
    'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
    'force_recalculate' => True, // bool
];
try {
    $result = $apiInstance->aggregateQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Исключение при вызове DefaultApi->aggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
}

bulkAggregateQuestionResults

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	query	Yes
forceRecalculate	boolean	query	No

Відповідь

Повертає: BulkAggregateQuestionResultsResponse

Приклад

bulkAggregateQuestionResults Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію за допомогою API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$bulk_aggregate_question_results_request = new \FastComments\Client\Model\BulkAggregateQuestionResultsRequest(); // \FastComments\Client\Model\BulkAggregateQuestionResultsRequest
$force_recalculate = True; // bool
try {
    $result = $apiInstance->bulkAggregateQuestionResults($tenant_id, $bulk_aggregate_question_results_request, $force_recalculate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->bulkAggregateQuestionResults: ', $e->getMessage(), PHP_EOL;
}

combineCommentsWithQuestionResults

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
questionId	string	query	No
questionIds	array	query	No
urlId	string	query	No
startDate	string	query	No
forceRecalculate	boolean	query	No
minValue	number	query	No
maxValue	number	query	No
limit	number	query	No

Ответ

Returns: CombineQuestionResultsWithCommentsResponse

Пример

combineCommentsWithQuestionResults Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройте авторизацию ключа API: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы настроить префикс (например, Bearer) для ключа API, если нужно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать пользовательский HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, `GuzzleHttp\Client` будет использован по умолчанию.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'question_id' => 'question_id_example', // строка
    'question_ids' => array('question_ids_example'), // строка[]
    'url_id' => 'url_id_example', // строка
    'start_date' => new \DateTime('2013-10-20T19:20:30+01:00'), // \DateTime
    'force_recalculate' => True, // bool
    'min_value' => 3.4, // float
    'max_value' => 3.4, // float
    'limit' => 3.4, // float
];
try {
    $result = $apiInstance->combineCommentsWithQuestionResults($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->combineCommentsWithQuestionResults: ', $e->getMessage(), PHP_EOL;
}

addSSOUser

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: AddSSOUserAPIResponse

Пример

Пример addSSOUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_apisso_user_data = new \FastComments\Client\Model\CreateAPISSOUserData(); // \FastComments\Client\Model\CreateAPISSOUserData
try {
    $result = $apiInstance->addSSOUser($tenant_id, $create_apisso_user_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addSSOUser: ', $e->getMessage(), PHP_EOL;
}

deleteSSOUser

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

Ответ

Возвращает: DeleteSSOUserAPIResponse

Пример

deleteSSOUser Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
$options = [
    'delete_comments' => True, // логическое
    'comment_delete_mode' => 'comment_delete_mode_example', // строка
];
try {
    $result = $apiInstance->deleteSSOUser($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteSSOUser: ', $e->getMessage(), PHP_EOL;
}

getSSOUserByEmail

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
email	string	path	Так

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Приклад

Приклад getSSOUserByEmail

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$email = 'email_example'; // string
try {
    $result = $apiInstance->getSSOUserByEmail($tenant_id, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUserByEmail: ', $e->getMessage(), PHP_EOL;
}

getSSOUserById

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да
id	string	path	Да

Ответ

Возвращает: GetSSOUserByIdAPIResponse

Пример

Пример getSSOUserById

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключом: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getSSOUserById($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUserById: ', $e->getMessage(), PHP_EOL;
}

getSSOUsers

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
skip	integer	query	Ні

Відповідь

Повертає: GetSSOUsersResponse

Приклад

getSSOUsers Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації за ключем API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$skip = 56; // int
try {
    $result = $apiInstance->getSSOUsers($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSSOUsers: ', $e->getMessage(), PHP_EOL;
}

patchSSOUser

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
id	string	path	Так
updateComments	boolean	query	Ні

Відповідь

Повертає: PatchSSOUserAPIResponse

Приклад

patchSSOUser Приклад

Copy

<?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'; // string
$id = 'id_example'; // string
$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
$update_comments = True; // bool
try {
    $result = $apiInstance->patchSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->patchSSOUser: ', $e->getMessage(), PHP_EOL;
}

putSSOUser

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

Відповідь

Returns: PutSSOUserAPIResponse

Приклад

putSSOUser Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
$update_apisso_user_data = new \FastComments\Client\Model\UpdateAPISSOUserData(); // \FastComments\Client\Model\UpdateAPISSOUserData
$update_comments = True; // логічний
try {
    $result = $apiInstance->putSSOUser($tenant_id, $id, $update_apisso_user_data, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putSSOUser: ', $e->getMessage(), PHP_EOL;
}

createSubscription

Параметри

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

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

Приклад createSubscription

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$create_api_user_subscription_data = new \FastComments\Client\Model\CreateAPIUserSubscriptionData(); // \FastComments\Client\Model\CreateAPIUserSubscriptionData
try {
    $result = $apiInstance->createSubscription($tenant_id, $create_api_user_subscription_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createSubscription: ', $e->getMessage(), PHP_EOL;
}

deleteSubscription

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: DeleteSubscriptionAPIResponse

Приклад

deleteSubscription Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->deleteSubscription($tenant_id, $id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteSubscription: ', $e->getMessage(), PHP_EOL;
}

getSubscriptions

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
userId	string	query	Ні

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад getSubscriptions

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію за допомогою API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->getSubscriptions($tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getSubscriptions: ', $e->getMessage(), PHP_EOL;
}

updateSubscription

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Ответ

Возвращает: UpdateSubscriptionAPIResponse

Пример

Пример updateSubscription

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // строка
$id = 'id_example'; // строка
$update_api_user_subscription_data = new \FastComments\Client\Model\UpdateAPIUserSubscriptionData(); // \FastComments\Client\Model\UpdateAPIUserSubscriptionData
$user_id = 'user_id_example'; // строка
try {
    $result = $apiInstance->updateSubscription($tenant_id, $id, $update_api_user_subscription_data, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateSubscription: ', $e->getMessage(), PHP_EOL;
}

getTenantDailyUsages

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

Відповідь

Повертає: GetTenantDailyUsagesResponse

Приклад

Приклад getTenantDailyUsages

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключем API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$options = [
    'year_number' => 3.4, // float
    'month_number' => 3.4, // float
    'day_number' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getTenantDailyUsages($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantDailyUsages: ', $e->getMessage(), PHP_EOL;
}

createTenantPackage

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateTenantPackageResponse

Пример

Пример createTenantPackage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_tenant_package_body = new \FastComments\Client\Model\CreateTenantPackageBody(); // \FastComments\Client\Model\CreateTenantPackageBody
try {
    $result = $apiInstance->createTenantPackage($tenant_id, $create_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenantPackage: ', $e->getMessage(), PHP_EOL;
}

deleteTenantPackage

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад deleteTenantPackage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію за ключем API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->deleteTenantPackage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenantPackage: ', $e->getMessage(), PHP_EOL;
}

getTenantPackage

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: GetTenantPackageResponse

Пример

Пример getTenantPackage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getTenantPackage($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantPackage: ', $e->getMessage(), PHP_EOL;
}

getTenantPackages

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да
skip	number	query	Нет

Ответ

Возвращает: GetTenantPackagesResponse

Пример

Пример getTenantPackages

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$skip = 3.4; // число с плавающей точкой
try {
    $result = $apiInstance->getTenantPackages($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantPackages: ', $e->getMessage(), PHP_EOL;
}

replaceTenantPackage

Parameters

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Response

Повертає: APIEmptyResponse

Приклад

replaceTenantPackage Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію за допомогою API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$replace_tenant_package_body = new \FastComments\Client\Model\ReplaceTenantPackageBody(); // \FastComments\Client\Model\ReplaceTenantPackageBody
try {
    $result = $apiInstance->replaceTenantPackage($tenant_id, $id, $replace_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->replaceTenantPackage: ', $e->getMessage(), PHP_EOL;
}

updateTenantPackage

Параметри

Назва	Тип	Розташування	Обовʼязково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад updateTenantPackage

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
$update_tenant_package_body = new \FastComments\Client\Model\UpdateTenantPackageBody(); // \FastComments\Client\Model\UpdateTenantPackageBody
try {
    $result = $apiInstance->updateTenantPackage($tenant_id, $id, $update_tenant_package_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenantPackage: ', $e->getMessage(), PHP_EOL;
}

createTenantUser

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateTenantUserResponse

Пример

Пример createTenantUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$create_tenant_user_body = new \FastComments\Client\Model\CreateTenantUserBody(); // \FastComments\Client\Model\CreateTenantUserBody
try {
    $result = $apiInstance->createTenantUser($tenant_id, $create_tenant_user_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenantUser: ', $e->getMessage(), PHP_EOL;
}

deleteTenantUser

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

Ответ

Возвращает: APIEmptyResponse

Пример

Пример deleteTenantUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию с помощью API‑ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
$options = [
    'delete_comments' => 'delete_comments_example', // строка
    'comment_delete_mode' => 'comment_delete_mode_example', // строка
];
try {
    $result = $apiInstance->deleteTenantUser($tenant_id, $id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenantUser: ', $e->getMessage(), PHP_EOL;
}

getTenantUser

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantUserResponse

Приклад

Приклад getTenantUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->getTenantUser($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantUser: ', $e->getMessage(), PHP_EOL;
}

getTenantUsers

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetTenantUsersResponse

Приклад

Приклад getTenantUsers

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$skip = 3.4; // float
try {
    $result = $apiInstance->getTenantUsers($tenant_id, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenantUsers: ', $e->getMessage(), PHP_EOL;
}

replaceTenantUser

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
updateComments	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

replaceTenantUser Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройте авторизацию ключом API: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы задать префикс (например, Bearer) для ключа API, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$replace_tenant_user_body = new \FastComments\Client\Model\ReplaceTenantUserBody(); // \FastComments\Client\Model\ReplaceTenantUserBody
$update_comments = 'update_comments_example'; // string
try {
    $result = $apiInstance->replaceTenantUser($tenant_id, $id, $replace_tenant_user_body, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->replaceTenantUser: ', $e->getMessage(), PHP_EOL;
}

sendLoginLink

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
id	string	path	Yes
redirectURL	string	query	No

Ответ

Возвращает: APIEmptyResponse

Пример

sendLoginLink Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию с помощью API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$redirect_url = 'redirect_url_example'; // string
try {
    $result = $apiInstance->sendLoginLink($tenant_id, $id, $redirect_url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->sendLoginLink: ', $e->getMessage(), PHP_EOL;
}

updateTenantUser

Параметры

Name	Type	Location	Required
tenantId	string	query	Да
id	string	path	Да
updateComments	string	query	Нет

Ответ

Возвращает: APIEmptyResponse

Пример

updateTenantUser Пример

Copy

<?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'; // string
$id = 'id_example'; // string
$update_tenant_user_body = new \FastComments\Client\Model\UpdateTenantUserBody(); // \FastComments\Client\Model\UpdateTenantUserBody
$update_comments = 'update_comments_example'; // string
try {
    $result = $apiInstance->updateTenantUser($tenant_id, $id, $update_tenant_user_body, $update_comments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenantUser: ', $e->getMessage(), PHP_EOL;
}

createTenant

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Да

Ответ

Возвращает: CreateTenantResponse

Пример

Пример createTenant

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$create_tenant_body = new \FastComments\Client\Model\CreateTenantBody(); // \FastComments\Client\Model\CreateTenantBody
try {
    $result = $apiInstance->createTenant($tenant_id, $create_tenant_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTenant: ', $e->getMessage(), PHP_EOL;
}

deleteTenant

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
id	string	path	Да
sure	string	query	Нет

Ответ

Returns: APIEmptyResponse

Пример

Пример deleteTenant

Copy

<?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'; // строка
$id = 'id_example'; // строка
$sure = 'sure_example'; // строка
try {
    $result = $apiInstance->deleteTenant($tenant_id, $id, $sure);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTenant: ', $e->getMessage(), PHP_EOL;
}

getTenant

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantResponse

Приклад

Приклад getTenant

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації за допомогою API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->getTenant($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenant: ', $e->getMessage(), PHP_EOL;
}

getTenants

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
meta	string	query	No
skip	number	query	No

Відповідь

Повертає: GetTenantsResponse

Приклад

Приклад getTenants

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$options = [
    'meta' => 'meta_example', // string
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getTenants($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTenants: ', $e->getMessage(), PHP_EOL;
}

updateTenant

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIEmptyResponse

Пример

Пример updateTenant

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$update_tenant_body = new \FastComments\Client\Model\UpdateTenantBody(); // \FastComments\Client\Model\UpdateTenantBody
try {
    $result = $apiInstance->updateTenant($tenant_id, $id, $update_tenant_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateTenant: ', $e->getMessage(), PHP_EOL;
}

changeTicketState

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Да
userId	string	query	Да
id	string	path	Да

Ответ

Возвращает: ChangeTicketStateResponse

Пример

Пример changeTicketState

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$user_id = 'user_id_example'; // строка
$id = 'id_example'; // строка
$change_ticket_state_body = new \FastComments\Client\Model\ChangeTicketStateBody(); // \FastComments\Client\Model\ChangeTicketStateBody
try {
    $result = $apiInstance->changeTicketState($tenant_id, $user_id, $id, $change_ticket_state_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->changeTicketState: ', $e->getMessage(), PHP_EOL;
}

createTicket

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Так
userId	string	query	Так

Response

Повертає: CreateTicketResponse

Example

Приклад createTicket

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$user_id = 'user_id_example'; // string
$create_ticket_body = new \FastComments\Client\Model\CreateTicketBody(); // \FastComments\Client\Model\CreateTicketBody
try {
    $result = $apiInstance->createTicket($tenant_id, $user_id, $create_ticket_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createTicket: ', $e->getMessage(), PHP_EOL;
}

getTicket

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No

Відповідь

Повертає: GetTicketResponse

Приклад

getTicket Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштувати авторизацію ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
$user_id = 'user_id_example'; // string
try {
    $result = $apiInstance->getTicket($tenant_id, $id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTicket: ', $e->getMessage(), PHP_EOL;
}

getTickets

Параметры

Имя	Тип	Расположение	Требуется
tenantId	string	query	Yes
userId	string	query	No
state	number	query	No
skip	number	query	No
limit	number	query	No

Ответ

Возвращает: GetTicketsResponse

Пример

Пример getTickets

Copy

<?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'; // строка
$options = [
    'user_id' => 'user_id_example', // строка
    'state' => 3.4, // число с плавающей запятой
    'skip' => 3.4, // число с плавающей запятой
    'limit' => 3.4, // число с плавающей запятой
];
try {
    $result = $apiInstance->getTickets($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getTickets: ', $e->getMessage(), PHP_EOL;
}

getTranslations

Параметры

Имя	Тип	Расположение	Обязательно
namespace	string	path	Yes
component	string	path	Yes
locale	string	query	No
useFullTranslationIds	boolean	query	No

Ответ

Returns: GetTranslationsResponse

Пример

getTranslations Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$namespace = 'namespace_example'; // string
$component = 'component_example'; // string
$options = [
    'locale' => 'locale_example', // string
    'use_full_translation_ids' => True, // bool
];
try {
    $result = $apiInstance->getTranslations($namespace, $component, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getTranslations: ', $e->getMessage(), PHP_EOL;
}

uploadImage

Upload and resize an image

Parameters

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	path	Yes
sizePreset	string	query	No	Профіль розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв)
urlId	string	query	No	ID сторінки, з якої відбувається завантаження, для налаштування

Response

Повертає: UploadImageResponse

Example

uploadImage приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, `GuzzleHttp\Client` буде використаний за замовчуванням.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$file = '/path/to/file.txt'; // \SplFileObject
$options = [
    'size_preset' => new \FastComments\Client\Model\\FastComments\Client\Model\SizePreset(), // \FastComments\Client\Model\SizePreset | Профіль розміру: \"Default\" (1000x1000px) або \"CrossPlatform\" (створює розміри для популярних пристроїв)
    'url_id' => 'url_id_example', // рядок | ID сторінки, з якої відбувається завантаження, для налаштування
];
try {
    $result = $apiInstance->uploadImage($tenant_id, $file, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->uploadImage: ', $e->getMessage(), PHP_EOL;
}

getUserBadgeProgressById

Параметри

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

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад getUserBadgeProgressById

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->getUserBadgeProgressById($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressById: ', $e->getMessage(), PHP_EOL;
}

getUserBadgeProgressByUserId

Parameters

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Да
userId	string	path	Да

Response

Returns: APIGetUserBadgeProgressResponse

Пример

Пример getUserBadgeProgressByUserId

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
// Настройка авторизации с помощью API-ключа: api_key
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Раскомментируйте ниже, чтобы установить префикс (например, Bearer) для API-ключа, если необходимо
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // Если вы хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    // Это опционально, будет использован `GuzzleHttp\Client` по умолчанию.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
// строка
$user_id = 'user_id_example'; // string
// строка
try {
    $result = $apiInstance->getUserBadgeProgressByUserId($tenant_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressByUserId: ', $e->getMessage(), PHP_EOL;
}

getUserBadgeProgressList

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Да
userId	string	query	Нет
limit	number	query	Нет
skip	number	query	Нет

Ответ

Возвращает: APIGetUserBadgeProgressListResponse

Пример

Пример getUserBadgeProgressList

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию ключом API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'limit' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getUserBadgeProgressList($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadgeProgressList: ', $e->getMessage(), PHP_EOL;
}

createUserBadge

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes

Відповідь

Повертає: APICreateUserBadgeResponse

Приклад

createUserBadge Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$create_user_badge_params = new \FastComments\Client\Model\CreateUserBadgeParams(); // \FastComments\Client\Model\CreateUserBadgeParams
try {
    $result = $apiInstance->createUserBadge($tenant_id, $create_user_badge_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createUserBadge: ', $e->getMessage(), PHP_EOL;
}

deleteUserBadge

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

deleteUserBadge Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$id = 'id_example'; // string
try {
    $result = $apiInstance->deleteUserBadge($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteUserBadge: ', $e->getMessage(), PHP_EOL;
}

getUserBadge

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIGetUserBadgeResponse

Пример

Пример getUserBadge

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
try {
    $result = $apiInstance->getUserBadge($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadge: ', $e->getMessage(), PHP_EOL;
}

getUserBadges

Параметри

Назва	Тип	Розташування	Обовʼязковий
tenantId	string	query	Так
userId	string	query	Ні
badgeId	string	query	Ні
type	number	query	Ні
displayedOnComments	boolean	query	Ні
limit	number	query	Ні
skip	number	query	Ні

Відповідь

Returns: APIGetUserBadgesResponse

Приклад

Приклад getUserBadges

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації ключа API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'badge_id' => 'badge_id_example', // string
    'type' => 3.4, // float
    'displayed_on_comments' => True, // bool
    'limit' => 3.4, // float
    'skip' => 3.4, // float
];
try {
    $result = $apiInstance->getUserBadges($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUserBadges: ', $e->getMessage(), PHP_EOL;
}

updateUserBadge

Параметры

Имя	Тип	Расположение	Обязательно	Описание
tenantId	string	query	Yes
id	string	path	Yes

Ответ

Возвращает: APIEmptySuccessResponse

Пример

Пример updateUserBadge

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$id = 'id_example'; // string
$update_user_badge_params = new \FastComments\Client\Model\UpdateUserBadgeParams(); // \FastComments\Client\Model\UpdateUserBadgeParams
try {
    $result = $apiInstance->updateUserBadge($tenant_id, $id, $update_user_badge_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateUserBadge: ', $e->getMessage(), PHP_EOL;
}

getUserNotificationCount

Параметры

Name	Type	Location	Required	Description
tenantId	string	query	Да
sso	string	query	Нет

Ответ

Возвращает: GetUserNotificationCountResponse

Пример

Пример getUserNotificationCount

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это опционально, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->getUserNotificationCount($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserNotificationCount: ', $e->getMessage(), PHP_EOL;
}

getUserNotifications

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Yes
urlId	string	query	No	Використовується для визначення, чи підписана поточна сторінка.
pageSize	integer	query	No
afterId	string	query	No
includeContext	boolean	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
includeTranslations	boolean	query	No
includeTenantNotifications	boolean	query	No
sso	string	query	No

Відповідь

Повертає: GetMyNotificationsResponse

Приклад

Приклад getUserNotifications

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$options = [
    'url_id' => 'url_id_example', // строка | Використовується для визначення, чи підписана поточна сторінка.
    'page_size' => 56, // int
    'after_id' => 'after_id_example', // строка
    'include_context' => True, // bool
    'after_created_at' => 56, // int
    'unread_only' => True, // bool
    'dm_only' => True, // bool
    'no_dm' => True, // bool
    'include_translations' => True, // bool
    'include_tenant_notifications' => True, // bool
    'sso' => 'sso_example', // строка
];
try {
    $result = $apiInstance->getUserNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
}

resetUserNotificationCount

Параметри

Назва	Тип	Місце	Обов’язково	Опис
tenantId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

resetUserNotificationCount Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$sso = 'sso_example'; // рядок
try {
    $result = $apiInstance->resetUserNotificationCount($tenant_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->resetUserNotificationCount: ', $e->getMessage(), PHP_EOL;
}

resetUserNotifications

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
afterId	string	query	Ні
afterCreatedAt	integer	query	Ні
unreadOnly	boolean	query	Ні
dmOnly	boolean	query	Ні
noDm	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

Приклад resetUserNotifications

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // рядок
$options = [
    'after_id' => 'after_id_example', // рядок
    'after_created_at' => 56, // ціле
    'unread_only' => True, // булевий
    'dm_only' => True, // булевий
    'no_dm' => True, // булевий
    'sso' => 'sso_example', // рядок
];
try {
    $result = $apiInstance->resetUserNotifications($tenant_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->resetUserNotifications: ', $e->getMessage(), PHP_EOL;
}

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

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

Response

Returns: UpdateUserNotificationCommentSubscriptionStatusResponse

Пример

updateUserNotificationCommentSubscriptionStatus Приклад

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если хотите использовать собственный HTTP‑клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$notification_id = 'notification_id_example'; // string
$opted_in_or_out = 'opted_in_or_out_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->updateUserNotificationCommentSubscriptionStatus($tenant_id, $notification_id, $opted_in_or_out, $comment_id, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
}

updateUserNotificationPageSubscriptionStatus

Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, сповіщення створюються для нових кореневих коментарів, і також

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
urlId	string	query	Так
url	string	query	Так
pageTitle	string	query	Так
subscribedOrUnsubscribed	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationPageSubscriptionStatusResponse

Приклад

Приклад updateUserNotificationPageSubscriptionStatus

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте ваш клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
$url = 'url_example'; // string
$page_title = 'page_title_example'; // string
$subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example'; // string
$sso = 'sso_example'; // string
try {
    $result = $apiInstance->updateUserNotificationPageSubscriptionStatus($tenant_id, $url_id, $url, $page_title, $subscribed_or_unsubscribed, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: ', $e->getMessage(), PHP_EOL;
}

updateUserNotificationStatus

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
notificationId	string	path	Yes
newStatus	string	path	Yes
sso	string	query	No

Ответ

Returns: UpdateUserNotificationStatusResponse

Пример

updateUserNotificationStatus Пример

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать пользовательский HTTP‑клиент, передайте ваш клиент, который реализует `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использоваться `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$notification_id = 'notification_id_example'; // строка
$new_status = 'new_status_example'; // строка
$sso = 'sso_example'; // строка
try {
    $result = $apiInstance->updateUserNotificationStatus($tenant_id, $notification_id, $new_status, $sso);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->updateUserNotificationStatus: ', $e->getMessage(), PHP_EOL;
}

getUserPresenceStatuses

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
urlIdWS	string	query	Yes
userIds	string	query	Yes

Відповідь

Повертає: GetUserPresenceStatusesResponse

Приклад

Приклад getUserPresenceStatuses

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Якщо ви хочете використовувати власний HTTP‑клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
    // Це необов’язково, за замовчуванням буде використано `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id_ws = 'url_id_ws_example'; // string
$user_ids = 'user_ids_example'; // string
try {
    $result = $apiInstance->getUserPresenceStatuses($tenant_id, $url_id_ws, $user_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->getUserPresenceStatuses: ', $e->getMessage(), PHP_EOL;
}

searchUsers

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	path	Yes
urlId	string	query	Yes
usernameStartsWith	string	query	No
mentionGroupIds	array	query	No
sso	string	query	No
searchSection	string	query	No

Ответ

Возвращает: SearchUsersResult

Пример

Пример searchUsers

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\PublicApi(
    // Если вы хотите использовать кастомный HTTP-клиент, передайте ваш клиент, реализующий `GuzzleHttp\ClientInterface`.
    // Это необязательно, по умолчанию будет использован `GuzzleHttp\Client`.
    new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // строка
$url_id = 'url_id_example'; // строка
$options = [
    'username_starts_with' => 'username_starts_with_example', // строка
    'mention_group_ids' => array('mention_group_ids_example'), // строка[]
    'sso' => 'sso_example', // строка
    'search_section' => 'search_section_example', // строка
];
try {
    $result = $apiInstance->searchUsers($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicApi->searchUsers: ', $e->getMessage(), PHP_EOL;
}

getUser

Параметри

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

Відповідь

Повертає: GetUserResponse

Приклад

Приклад getUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштування авторизації API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // рядок
$id = 'id_example'; // рядок
try {
    $result = $apiInstance->getUser($tenant_id, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getUser: ', $e->getMessage(), PHP_EOL;
}

createVote

Параметры

Имя	Тип	Местоположение	Обязательно
tenantId	string	query	Yes
commentId	string	query	Yes
direction	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

Ответ

Возвращает: VoteResponse

Пример

Пример createVote

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройте авторизацию API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$comment_id = 'comment_id_example'; // string
$direction = 'direction_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->createVote($tenant_id, $comment_id, $direction, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createVote: ', $e->getMessage(), PHP_EOL;
}

deleteVote

Параметры

Имя	Тип	Расположение	Обязательно
tenantId	string	query	Да
id	string	path	Да
editKey	string	query	Нет

Ответ

Возвращает: VoteDeleteResponse

Пример

Пример deleteVote

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Настройка авторизации API-ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // строка
$id = 'id_example'; // строка
$edit_key = 'edit_key_example'; // строка
try {
    $result = $apiInstance->deleteVote($tenant_id, $id, $edit_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteVote: ', $e->getMessage(), PHP_EOL;
}

getVotes

Параметры

Имя	Тип	Местоположение	Обязательно	Описание
tenantId	string	query	Yes
urlId	string	query	Yes

Ответ

Возвращает: GetVotesResponse

Пример

Пример getVotes

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
    $result = $apiInstance->getVotes($tenant_id, $url_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getVotes: ', $e->getMessage(), PHP_EOL;
}

getVotesForUser

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
urlId	string	query	Yes
userId	string	query	No
anonUserId	string	query	No

Відповідь

Повертає: GetVotesForUserResponse

Приклад

Приклад getVotesForUser

Copy

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію за допомогою API ключа: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$url_id = 'url_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'anon_user_id' => 'anon_user_id_example', // string
];
try {
    $result = $apiInstance->getVotesForUser($tenant_id, $url_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getVotesForUser: ', $e->getMessage(), PHP_EOL;
}

Нужна помощь?

Если у вас возникнут какие-либо проблемы или вопросы по PHP SDK, пожалуйста:

Участие

Вклады приветствуются! Пожалуйста, посетите репозиторий на GitHub для получения рекомендаций по внесению вкладов.

Язык 🇺🇦 Русский (Украина)

Начало работы

Справочник API

Документация

Аутентификация

Агрегация

Журналы аудита

Блокировка по комментарию

Проверка заблокированных комментариев

Комментарии

Комментарии пользователя

Настройки домена

Шаблоны писем

Журнал событий

Посты ленты

Пометка комментария

GIF

Хештеги

Модерация

Модераторы

Количество уведомлений

Уведомления

Реакции страницы

Страницы

Ожидающие события вебхука

Настройки вопросов

Результаты вопросов

Агрегация результатов вопросов

Пользователи SSO

Подписки

Ежедневное использование тенанта

Пакеты тенанта

Пользователи тенанта

Тенанты

Тикеты

Переводы

Загрузка изображения

Прогресс значков пользователя

Значки пользователя

Уведомления пользователя

Статусы присутствия пользователя

Поиск пользователей

Пользователи

Голоса

FastComments PHP SDK

Репозиторий

Установка и использование

Требования

Composer

Ручная установка

Начало работы

Клиенты API

Использование PublicApi

Использование ModerationApi

Методы API

Модели

Авторизация

api_key

Автор

aggregate

Параметры

Ответ

Пример

getAuditLogs

Parameters

Response

Example

logoutPublic

Ответ

Пример

blockFromCommentPublic

Параметры

Ответ

Пример

unBlockCommentPublic

Параметри

Відповідь

Приклад

checkedCommentsForBlocked

Параметры