FastComments\Client\ModerationApi

All URIs are relative to https://fastcomments.com, except if the operation defines another base path.

Method	HTTP request	Description
deleteModerationVote()	DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId}
getApiComments()	GET /auth/my-account/moderate-comments/mod_api/api/comments
getApiExportStatus()	GET /auth/my-account/moderate-comments/mod_api/api/export/status
getApiIds()	GET /auth/my-account/moderate-comments/mod_api/api/ids
getBanUsersFromComment()	GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId}
getCommentBanStatus()	GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId}
getCommentChildren()	GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId}
getCount()	GET /auth/my-account/moderate-comments/mod_api/count
getCounts()	GET /auth/my-account/moderate-comments/banned-users/mod_api/counts
getLogs()	GET /auth/my-account/moderate-comments/mod_api/logs/{commentId}
getManualBadges()	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges
getManualBadgesForUser()	GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user
getModerationComment()	GET /auth/my-account/moderate-comments/mod_api/comment/{commentId}
getModerationCommentText()	GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId}
getPreBanSummary()	GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId}
getSearchCommentsSummary()	GET /auth/my-account/moderate-comments/mod_api/search/comments/summary
getSearchPages()	GET /auth/my-account/moderate-comments/mod_api/search/pages
getSearchSites()	GET /auth/my-account/moderate-comments/mod_api/search/sites
getSearchSuggest()	GET /auth/my-account/moderate-comments/mod_api/search/suggest
getSearchUsers()	GET /auth/my-account/moderate-comments/mod_api/search/users
getTrustFactor()	GET /auth/my-account/moderate-comments/mod_api/get-trust-factor
getUserBanPreference()	GET /auth/my-account/moderate-comments/mod_api/user-ban-preference
getUserInternalProfile()	GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile
postAdjustCommentVotes()	POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId}
postApiExport()	POST /auth/my-account/moderate-comments/mod_api/api/export
postBanUserFromComment()	POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId}
postBanUserUndo()	POST /auth/my-account/moderate-comments/mod_api/ban-user/undo
postBulkPreBanSummary()	POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary
postCommentsByIds()	POST /auth/my-account/moderate-comments/mod_api/comments-by-ids
postFlagComment()	POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId}
postRemoveComment()	POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId}
postRestoreDeletedComment()	POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId}
postSetCommentApprovalStatus()	POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId}
postSetCommentReviewStatus()	POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId}
postSetCommentSpamStatus()	POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId}
postSetCommentText()	POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId}
postUnFlagComment()	POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId}
postVote()	POST /auth/my-account/moderate-comments/mod_api/vote/{commentId}
putAwardBadge()	PUT /auth/my-account/moderate-comments/mod_api/award-badge
putCloseThread()	PUT /auth/my-account/moderate-comments/mod_api/close-thread
putRemoveBadge()	PUT /auth/my-account/moderate-comments/mod_api/remove-badge
putReopenThread()	PUT /auth/my-account/moderate-comments/mod_api/reopen-thread
setTrustFactor()	PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor

`deleteModerationVote()`

deleteModerationVote($tenant_id, $comment_id, $vote_id, $options): \FastComments\Client\Model\VoteDeleteResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
vote_id	string
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\VoteDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApiComments()`

getApiComments($tenant_id, $options): \FastComments\Client\Model\ModerationAPIGetCommentsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'page' => 3.4, // float
    'count' => 3.4, // float
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'sorts' => 'sorts_example', // string
    'demo' => True, // bool
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
page	float	[optional]
count	float	[optional]
text_search	string	[optional]
by_ip_from_comment	string	[optional]
filters	string	[optional]
search_filters	string	[optional]
sorts	string	[optional]
demo	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPIGetCommentsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApiExportStatus()`

getApiExportStatus($tenant_id, $options): \FastComments\Client\Model\ModerationExportStatusResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
batch_job_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationExportStatusResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApiIds()`

getApiIds($tenant_id, $options): \FastComments\Client\Model\ModerationAPIGetCommentIdsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'after_id' => 'after_id_example', // string
    'demo' => True, // bool
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
text_search	string	[optional]
by_ip_from_comment	string	[optional]
filters	string	[optional]
search_filters	string	[optional]
after_id	string	[optional]
demo	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPIGetCommentIdsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBanUsersFromComment()`

getBanUsersFromComment($tenant_id, $comment_id, $sso): \FastComments\Client\Model\GetBannedUsersFromCommentResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string


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

Parameters

Name	Type	Notes
tenant_id	string
comment_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\GetBannedUsersFromCommentResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCommentBanStatus()`

getCommentBanStatus($tenant_id, $comment_id, $sso): \FastComments\Client\Model\GetCommentBanStatusResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$sso = 'sso_example'; // string


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

Parameters

Name	Type	Notes
tenant_id	string
comment_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\GetCommentBanStatusResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCommentChildren()`

getCommentChildren($tenant_id, $comment_id, $sso): \FastComments\Client\Model\ModerationAPIChildCommentsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Notes
tenant_id	string
comment_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPIChildCommentsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCount()`

getCount($tenant_id, $options): \FastComments\Client\Model\ModerationAPICountCommentsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
text_search	string	[optional]
by_ip_from_comment	string	[optional]
filter	string	[optional]
search_filters	string	[optional]
demo	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPICountCommentsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCounts()`

getCounts($tenant_id, $sso): \FastComments\Client\Model\GetBannedUsersCountResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Description	Notes
tenant_id	string
sso	string		[optional]

Return type

\FastComments\Client\Model\GetBannedUsersCountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getLogs()`

getLogs($tenant_id, $comment_id, $sso): \FastComments\Client\Model\ModerationAPIGetLogsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Notes
tenant_id	string
comment_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPIGetLogsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getManualBadges()`

getManualBadges($tenant_id, $sso): \FastComments\Client\Model\GetTenantManualBadgesResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Description	Notes
tenant_id	string
sso	string		[optional]

Return type

\FastComments\Client\Model\GetTenantManualBadgesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getManualBadgesForUser()`

getManualBadgesForUser($tenant_id, $options): \FastComments\Client\Model\GetUserManualBadgesResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'badges_user_id' => 'badges_user_id_example', // string
    'comment_id' => 'comment_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
badges_user_id	string	[optional]
comment_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\GetUserManualBadgesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getModerationComment()`

getModerationComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\ModerationAPICommentResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'include_email' => True, // bool
    'include_ip' => True, // bool
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
include_email	bool	[optional]
include_ip	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPICommentResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getModerationCommentText()`

getModerationCommentText($tenant_id, $comment_id, $sso): \FastComments\Client\Model\GetCommentTextResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Notes
tenant_id	string
comment_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\GetCommentTextResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPreBanSummary()`

getPreBanSummary($tenant_id, $comment_id, $options): \FastComments\Client\Model\PreBanSummary

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$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->getPreBanSummary($tenant_id, $comment_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->getPreBanSummary: ', $e->getMessage(), PHP_EOL;
}

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
include_by_user_id_and_email	bool	[optional]
include_by_ip	bool	[optional]
include_by_email_domain	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\PreBanSummary

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSearchCommentsSummary()`

getSearchCommentsSummary($tenant_id, $options): \FastComments\Client\Model\ModerationCommentSearchResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
value	string	[optional]
filters	string	[optional]
search_filters	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationCommentSearchResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSearchPages()`

getSearchPages($tenant_id, $options): \FastComments\Client\Model\ModerationPageSearchResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
value	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationPageSearchResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSearchSites()`

getSearchSites($tenant_id, $options): \FastComments\Client\Model\ModerationSiteSearchResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
value	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationSiteSearchResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSearchSuggest()`

getSearchSuggest($tenant_id, $options): \FastComments\Client\Model\ModerationSuggestResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
text_search	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationSuggestResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSearchUsers()`

getSearchUsers($tenant_id, $options): \FastComments\Client\Model\ModerationUserSearchResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
value	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationUserSearchResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getTrustFactor()`

getTrustFactor($tenant_id, $options): \FastComments\Client\Model\GetUserTrustFactorResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
user_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\GetUserTrustFactorResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getUserBanPreference()`

getUserBanPreference($tenant_id, $sso): \FastComments\Client\Model\APIModerateGetUserBanPreferencesResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$sso = 'sso_example'; // string


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

Parameters

Name	Type	Description	Notes
tenant_id	string
sso	string		[optional]

Return type

\FastComments\Client\Model\APIModerateGetUserBanPreferencesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getUserInternalProfile()`

getUserInternalProfile($tenant_id, $options): \FastComments\Client\Model\GetUserInternalProfileResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'comment_id' => 'comment_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\GetUserInternalProfileResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postAdjustCommentVotes()`

postAdjustCommentVotes($tenant_id, $comment_id, $adjust_comment_votes_params, $options): \FastComments\Client\Model\AdjustVotesResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
adjust_comment_votes_params	\FastComments\Client\Model\AdjustCommentVotesParams
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\AdjustVotesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postApiExport()`

postApiExport($tenant_id, $options): \FastComments\Client\Model\ModerationExportResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'text_search' => 'text_search_example', // string
    'by_ip_from_comment' => 'by_ip_from_comment_example', // string
    'filters' => 'filters_example', // string
    'search_filters' => 'search_filters_example', // string
    'sorts' => 'sorts_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
text_search	string	[optional]
by_ip_from_comment	string	[optional]
filters	string	[optional]
search_filters	string	[optional]
sorts	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationExportResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postBanUserFromComment()`

postBanUserFromComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\BanUserFromCommentResult

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
ban_email	bool	[optional]
ban_email_domain	bool	[optional]
ban_ip	bool	[optional]
delete_all_users_comments	bool	[optional]
banned_until	string	[optional]
is_shadow_ban	bool	[optional]
update_id	string	[optional]
ban_reason	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\BanUserFromCommentResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postBanUserUndo()`

postBanUserUndo($tenant_id, $ban_user_undo_params, $sso): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$ban_user_undo_params = new \FastComments\Client\Model\BanUserUndoParams(); // \FastComments\Client\Model\BanUserUndoParams
$sso = 'sso_example'; // string


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

Parameters

Name	Type	Notes
tenant_id	string
ban_user_undo_params	\FastComments\Client\Model\BanUserUndoParams
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postBulkPreBanSummary()`

postBulkPreBanSummary($tenant_id, $bulk_pre_ban_params, $options): \FastComments\Client\Model\BulkPreBanSummary

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
bulk_pre_ban_params	\FastComments\Client\Model\BulkPreBanParams
include_by_user_id_and_email	bool	[optional]
include_by_ip	bool	[optional]
include_by_email_domain	bool	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\BulkPreBanSummary

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postCommentsByIds()`

postCommentsByIds($tenant_id, $comments_by_ids_params, $sso): \FastComments\Client\Model\ModerationAPIChildCommentsResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comments_by_ids_params = new \FastComments\Client\Model\CommentsByIdsParams(); // \FastComments\Client\Model\CommentsByIdsParams
$sso = 'sso_example'; // string


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

Parameters

Name	Type	Notes
tenant_id	string
comments_by_ids_params	\FastComments\Client\Model\CommentsByIdsParams
sso	string	[optional]

Return type

\FastComments\Client\Model\ModerationAPIChildCommentsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postFlagComment()`

postFlagComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postRemoveComment()`

postRemoveComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\PostRemoveCommentApiResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\PostRemoveCommentApiResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postRestoreDeletedComment()`

postRestoreDeletedComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSetCommentApprovalStatus()`

postSetCommentApprovalStatus($tenant_id, $comment_id, $options): \FastComments\Client\Model\SetCommentApprovedResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
approved	bool	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\SetCommentApprovedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSetCommentReviewStatus()`

postSetCommentReviewStatus($tenant_id, $comment_id, $options): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'reviewed' => True, // bool
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
reviewed	bool	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSetCommentSpamStatus()`

postSetCommentSpamStatus($tenant_id, $comment_id, $options): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
spam	bool	[optional]
perm_not_spam	bool	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSetCommentText()`

postSetCommentText($tenant_id, $comment_id, $set_comment_text_params, $options): \FastComments\Client\Model\SetCommentTextResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$set_comment_text_params = new \FastComments\Client\Model\SetCommentTextParams(); // \FastComments\Client\Model\SetCommentTextParams
$options = [
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
set_comment_text_params	\FastComments\Client\Model\SetCommentTextParams
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\SetCommentTextResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postUnFlagComment()`

postUnFlagComment($tenant_id, $comment_id, $options): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postVote()`

postVote($tenant_id, $comment_id, $options): \FastComments\Client\Model\VoteResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$comment_id = 'comment_id_example'; // string
$options = [
    'direction' => 'direction_example', // string
    'broadcast_id' => 'broadcast_id_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
comment_id	string
direction	string	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\VoteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putAwardBadge()`

putAwardBadge($tenant_id, $badge_id, $options): \FastComments\Client\Model\AwardUserBadgeResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$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->putAwardBadge($tenant_id, $badge_id, $options);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ModerationApi->putAwardBadge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
badge_id	string
user_id	string	[optional]
comment_id	string	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\AwardUserBadgeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putCloseThread()`

putCloseThread($tenant_id, $url_id, $sso): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Notes
tenant_id	string
url_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putRemoveBadge()`

putRemoveBadge($tenant_id, $badge_id, $options): \FastComments\Client\Model\RemoveUserBadgeResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
badge_id	string
user_id	string	[optional]
comment_id	string	[optional]
broadcast_id	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\RemoveUserBadgeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putReopenThread()`

putReopenThread($tenant_id, $url_id, $sso): \FastComments\Client\Model\APIEmptyResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

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

Parameters

Name	Type	Notes
tenant_id	string
url_id	string
sso	string	[optional]

Return type

\FastComments\Client\Model\APIEmptyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`setTrustFactor()`

setTrustFactor($tenant_id, $options): \FastComments\Client\Model\SetUserTrustFactorResponse

Example

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



$apiInstance = new FastComments\Client\Api\ModerationApi(
    // 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()
);

$tenant_id = 'tenant_id_example'; // string
$options = [
    'user_id' => 'user_id_example', // string
    'trust_factor' => 'trust_factor_example', // string
    'sso' => 'sso_example', // string
];


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

Parameters

Note: required parameters and the request body are positional; the optional parameters listed below are passed as keys of the $options array.

Name	Type	Notes
tenant_id	string
user_id	string	[optional]
trust_factor	string	[optional]
sso	string	[optional]

Return type

\FastComments\Client\Model\SetUserTrustFactorResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

ModerationApi.md

Latest commit

History

ModerationApi.md

File metadata and controls

FastComments\Client\ModerationApi

deleteModerationVote()

Example

Parameters

Return type

Authorization

HTTP request headers

getApiComments()

Example

Parameters

Return type

Authorization

HTTP request headers

getApiExportStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

getApiIds()

Example

Parameters

Return type

Authorization

HTTP request headers

getBanUsersFromComment()

Example

Parameters

Return type

Authorization

HTTP request headers

getCommentBanStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

getCommentChildren()

Example

Parameters

Return type

Authorization

HTTP request headers

getCount()

Example

Parameters

Return type

Authorization

HTTP request headers

getCounts()

Example

Parameters

Return type

Authorization

HTTP request headers

getLogs()

Example

Parameters

Return type

Authorization

HTTP request headers

getManualBadges()

Example

Parameters

Return type

Authorization

HTTP request headers

getManualBadgesForUser()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteModerationVote()`

`getApiComments()`

`getApiExportStatus()`

`getApiIds()`

`getBanUsersFromComment()`

`getCommentBanStatus()`

`getCommentChildren()`

`getCount()`

`getCounts()`

`getLogs()`

`getManualBadges()`

`getManualBadgesForUser()`

`getModerationComment()`

`getModerationCommentText()`

`getPreBanSummary()`

`getSearchCommentsSummary()`

`getSearchPages()`

`getSearchSites()`

`getSearchSuggest()`

`getSearchUsers()`

`getTrustFactor()`

`getUserBanPreference()`

`getUserInternalProfile()`