Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,8 @@
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

# Preserve the hand-written "API Clients / Using PublicApi / Using ModerationApi" prose
# in README.md. update.sh does not delete this ignore file or README.md, so the generator
# honors this and leaves README.md untouched on regen.
README.md
11 changes: 4 additions & 7 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.gitignore
.php-cs-fixer.dist.php
.travis.yml
README.md
composer.json
docs/Api/DefaultApi.md
docs/Api/ModerationApi.md
Expand Down Expand Up @@ -265,7 +264,7 @@ docs/Model/PatchDomainConfigResponse.md
docs/Model/PatchPageAPIResponse.md
docs/Model/PatchSSOUserAPIResponse.md
docs/Model/PendingCommentToSyncOutbound.md
docs/Model/PostRemoveCommentResponse.md
docs/Model/PostRemoveCommentApiResponse.md
docs/Model/PreBanSummary.md
docs/Model/PubSubComment.md
docs/Model/PubSubCommentBase.md
Expand Down Expand Up @@ -364,7 +363,6 @@ docs/Model/UsersListLocation.md
docs/Model/VoteBodyParams.md
docs/Model/VoteDeleteResponse.md
docs/Model/VoteResponse.md
docs/Model/VoteResponseStatus.md
docs/Model/VoteResponseUser.md
docs/Model/VoteStyle.md
git_push.sh
Expand All @@ -373,6 +371,7 @@ lib/Api/ModerationApi.php
lib/Api/PublicApi.php
lib/ApiException.php
lib/Configuration.php
lib/FormDataProcessor.php
lib/HeaderSelector.php
lib/Model/APIAuditLog.php
lib/Model/APIBanUserChangeLog.php
Expand Down Expand Up @@ -634,7 +633,7 @@ lib/Model/PatchDomainConfigResponse.php
lib/Model/PatchPageAPIResponse.php
lib/Model/PatchSSOUserAPIResponse.php
lib/Model/PendingCommentToSyncOutbound.php
lib/Model/PostRemoveCommentResponse.php
lib/Model/PostRemoveCommentApiResponse.php
lib/Model/PreBanSummary.php
lib/Model/PubSubComment.php
lib/Model/PubSubCommentBase.php
Expand Down Expand Up @@ -733,7 +732,6 @@ lib/Model/UsersListLocation.php
lib/Model/VoteBodyParams.php
lib/Model/VoteDeleteResponse.php
lib/Model/VoteResponse.php
lib/Model/VoteResponseStatus.php
lib/Model/VoteResponseUser.php
lib/Model/VoteStyle.php
lib/ObjectSerializer.php
Expand Down Expand Up @@ -1000,7 +998,7 @@ test/Model/PatchDomainConfigResponseTest.php
test/Model/PatchPageAPIResponseTest.php
test/Model/PatchSSOUserAPIResponseTest.php
test/Model/PendingCommentToSyncOutboundTest.php
test/Model/PostRemoveCommentResponseTest.php
test/Model/PostRemoveCommentApiResponseTest.php
test/Model/PreBanSummaryTest.php
test/Model/PubSubCommentBaseTest.php
test/Model/PubSubCommentTest.php
Expand Down Expand Up @@ -1098,7 +1096,6 @@ test/Model/UserTest.php
test/Model/UsersListLocationTest.php
test/Model/VoteBodyParamsTest.php
test/Model/VoteDeleteResponseTest.php
test/Model/VoteResponseStatusTest.php
test/Model/VoteResponseTest.php
test/Model/VoteResponseUserTest.php
test/Model/VoteStyleTest.php
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.12.0
7.23.0-SNAPSHOT
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ try {

The SDK exposes three API client classes:

- **`DefaultApi`** API-key-authenticated methods for server-side use. Configure an API key as shown in [Getting Started](#getting-started).
- **`PublicApi`** public methods that do not require an API key, safe to call from browsers and mobile apps.
- **`ModerationApi`** — methods for the moderator dashboard: listing, counting, searching, logging and exporting comments; moderation actions (remove/restore, flag, set review/spam/approval status, votes, reopen/close thread); bans (ban from comment, undo, pre-ban summaries, ban status and preferences, banned-user counts); and badges & trust (award/remove badge, manual badges, get/set trust factor, user internal profile). Every `ModerationApi` method accepts an `$sso` parameter to authenticate the acting moderator via SSO.
- **`DefaultApi`** - API-key-authenticated methods for server-side use. Configure an API key as shown in [Getting Started](#getting-started).
- **`PublicApi`** - public methods that do not require an API key, safe to call from browsers and mobile apps.
- **`ModerationApi`** - an extensive suite of live and fast moderation APIs. Every `ModerationApi` method accepts an `$sso` parameter and can authenticate via SSO or a FastComments.com session cookie.

### Using PublicApi

Expand Down Expand Up @@ -114,7 +114,9 @@ $apiInstance = new FastComments\Client\Api\ModerationApi(
$sso = 'sso_example'; // string - SSO payload authenticating the moderator

try {
$result = $apiInstance->getCount(null, null, null, null, null, $sso);
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
}
],
"require": {
"php": "^7.4 || ^8.0",
"php": "^8.1",
"ext-curl": "*",
"ext-json": "*",
"ext-mbstring": "*",
Expand Down
Loading
Loading