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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,7 @@ to make working with the API easier, and the `pubsub` module which is a library
For the API client, there are three classes, `DefaultApi`, `PublicApi`, and `ModerationApi`. The `DefaultApi` contains methods that require your API key, and `PublicApi` contains methods
that can be made directly from a browser/mobile device/etc without authentication.

The `ModerationApi` powers the moderator dashboard. It contains methods for comment moderation (list, count, search, logs, and export), moderation actions (remove/restore,
flag, set review/spam/approval status, votes, and reopen/close thread), bans (ban from comment, undo a ban, pre-ban summaries, ban status and preferences, and banned-user counts),
and badges & trust (award/remove a badge, manual badges, get/set trust factor, and user internal profile). Every `ModerationApi` method accepts an `sso` parameter so the call can be
performed on behalf of an SSO-authenticated moderator.
The `ModerationApi` provides 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.

## Quick Start

Expand Down
6 changes: 3 additions & 3 deletions client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ docs/PatchDomainConfigResponse.md
docs/PatchPageAPIResponse.md
docs/PatchSSOUserAPIResponse.md
docs/PendingCommentToSyncOutbound.md
docs/PostRemoveCommentResponse.md
docs/PostRemoveCommentApiResponse.md
docs/PreBanSummary.md
docs/PubSubComment.md
docs/PubSubCommentBase.md
Expand Down Expand Up @@ -657,7 +657,7 @@ src/main/java/com/fastcomments/model/PatchDomainConfigResponse.java
src/main/java/com/fastcomments/model/PatchPageAPIResponse.java
src/main/java/com/fastcomments/model/PatchSSOUserAPIResponse.java
src/main/java/com/fastcomments/model/PendingCommentToSyncOutbound.java
src/main/java/com/fastcomments/model/PostRemoveCommentResponse.java
src/main/java/com/fastcomments/model/PostRemoveCommentApiResponse.java
src/main/java/com/fastcomments/model/PreBanSummary.java
src/main/java/com/fastcomments/model/PubSubComment.java
src/main/java/com/fastcomments/model/PubSubCommentBase.java
Expand Down Expand Up @@ -1020,7 +1020,7 @@ src/test/java/com/fastcomments/model/PatchDomainConfigResponseTest.java
src/test/java/com/fastcomments/model/PatchPageAPIResponseTest.java
src/test/java/com/fastcomments/model/PatchSSOUserAPIResponseTest.java
src/test/java/com/fastcomments/model/PendingCommentToSyncOutboundTest.java
src/test/java/com/fastcomments/model/PostRemoveCommentResponseTest.java
src/test/java/com/fastcomments/model/PostRemoveCommentApiResponseTest.java
src/test/java/com/fastcomments/model/PreBanSummaryTest.java
src/test/java/com/fastcomments/model/PubSubCommentBaseTest.java
src/test/java/com/fastcomments/model/PubSubCommentTest.java
Expand Down
88 changes: 44 additions & 44 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,49 +237,49 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**updateTenantPackage**](docs/DefaultApi.md#updateTenantPackage) | **PATCH** /api/v1/tenant-packages/{id} |
*DefaultApi* | [**updateTenantUser**](docs/DefaultApi.md#updateTenantUser) | **PATCH** /api/v1/tenant-users/{id} |
*DefaultApi* | [**updateUserBadge**](docs/DefaultApi.md#updateUserBadge) | **PUT** /api/v1/user-badges/{id} |
*ModerationApi* | [**deleteModerationVote**](docs/ModerationApi.md#deleteModerationVote) | **DELETE** /auth/my-account/moderate-comments/vote/{commentId}/{voteId} |
*ModerationApi* | [**getApiComments**](docs/ModerationApi.md#getApiComments) | **GET** /auth/my-account/moderate-comments/api/comments |
*ModerationApi* | [**getApiExportStatus**](docs/ModerationApi.md#getApiExportStatus) | **GET** /auth/my-account/moderate-comments/api/export/status |
*ModerationApi* | [**getApiIds**](docs/ModerationApi.md#getApiIds) | **GET** /auth/my-account/moderate-comments/api/ids |
*ModerationApi* | [**getBanUsersFromComment**](docs/ModerationApi.md#getBanUsersFromComment) | **GET** /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} |
*ModerationApi* | [**getCommentBanStatus**](docs/ModerationApi.md#getCommentBanStatus) | **GET** /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} |
*ModerationApi* | [**getCommentChildren**](docs/ModerationApi.md#getCommentChildren) | **GET** /auth/my-account/moderate-comments/comment-children/{commentId} |
*ModerationApi* | [**getCount**](docs/ModerationApi.md#getCount) | **GET** /auth/my-account/moderate-comments/count |
*ModerationApi* | [**getCounts**](docs/ModerationApi.md#getCounts) | **GET** /auth/my-account/moderate-comments/banned-users/counts |
*ModerationApi* | [**getLogs**](docs/ModerationApi.md#getLogs) | **GET** /auth/my-account/moderate-comments/logs/{commentId} |
*ModerationApi* | [**getManualBadges**](docs/ModerationApi.md#getManualBadges) | **GET** /auth/my-account/moderate-comments/get-manual-badges |
*ModerationApi* | [**getManualBadgesForUser**](docs/ModerationApi.md#getManualBadgesForUser) | **GET** /auth/my-account/moderate-comments/get-manual-badges-for-user |
*ModerationApi* | [**getModerationComment**](docs/ModerationApi.md#getModerationComment) | **GET** /auth/my-account/moderate-comments/comment/{commentId} |
*ModerationApi* | [**getModerationCommentText**](docs/ModerationApi.md#getModerationCommentText) | **GET** /auth/my-account/moderate-comments/get-comment-text/{commentId} |
*ModerationApi* | [**getPreBanSummary**](docs/ModerationApi.md#getPreBanSummary) | **GET** /auth/my-account/moderate-comments/pre-ban-summary/{commentId} |
*ModerationApi* | [**getSearchCommentsSummary**](docs/ModerationApi.md#getSearchCommentsSummary) | **GET** /auth/my-account/moderate-comments/search/comments/summary |
*ModerationApi* | [**getSearchPages**](docs/ModerationApi.md#getSearchPages) | **GET** /auth/my-account/moderate-comments/search/pages |
*ModerationApi* | [**getSearchSites**](docs/ModerationApi.md#getSearchSites) | **GET** /auth/my-account/moderate-comments/search/sites |
*ModerationApi* | [**getSearchSuggest**](docs/ModerationApi.md#getSearchSuggest) | **GET** /auth/my-account/moderate-comments/search/suggest |
*ModerationApi* | [**getSearchUsers**](docs/ModerationApi.md#getSearchUsers) | **GET** /auth/my-account/moderate-comments/search/users |
*ModerationApi* | [**getTrustFactor**](docs/ModerationApi.md#getTrustFactor) | **GET** /auth/my-account/moderate-comments/get-trust-factor |
*ModerationApi* | [**getUserBanPreference**](docs/ModerationApi.md#getUserBanPreference) | **GET** /auth/my-account/moderate-comments/user-ban-preference |
*ModerationApi* | [**getUserInternalProfile**](docs/ModerationApi.md#getUserInternalProfile) | **GET** /auth/my-account/moderate-comments/get-user-internal-profile |
*ModerationApi* | [**postAdjustCommentVotes**](docs/ModerationApi.md#postAdjustCommentVotes) | **POST** /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} |
*ModerationApi* | [**postApiExport**](docs/ModerationApi.md#postApiExport) | **POST** /auth/my-account/moderate-comments/api/export |
*ModerationApi* | [**postBanUserFromComment**](docs/ModerationApi.md#postBanUserFromComment) | **POST** /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} |
*ModerationApi* | [**postBanUserUndo**](docs/ModerationApi.md#postBanUserUndo) | **POST** /auth/my-account/moderate-comments/ban-user/undo |
*ModerationApi* | [**postBulkPreBanSummary**](docs/ModerationApi.md#postBulkPreBanSummary) | **POST** /auth/my-account/moderate-comments/bulk-pre-ban-summary |
*ModerationApi* | [**postCommentsByIds**](docs/ModerationApi.md#postCommentsByIds) | **POST** /auth/my-account/moderate-comments/comments-by-ids |
*ModerationApi* | [**postFlagComment**](docs/ModerationApi.md#postFlagComment) | **POST** /auth/my-account/moderate-comments/flag-comment/{commentId} |
*ModerationApi* | [**postRemoveComment**](docs/ModerationApi.md#postRemoveComment) | **POST** /auth/my-account/moderate-comments/remove-comment/{commentId} |
*ModerationApi* | [**postRestoreDeletedComment**](docs/ModerationApi.md#postRestoreDeletedComment) | **POST** /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} |
*ModerationApi* | [**postSetCommentApprovalStatus**](docs/ModerationApi.md#postSetCommentApprovalStatus) | **POST** /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} |
*ModerationApi* | [**postSetCommentReviewStatus**](docs/ModerationApi.md#postSetCommentReviewStatus) | **POST** /auth/my-account/moderate-comments/set-comment-review-status/{commentId} |
*ModerationApi* | [**postSetCommentSpamStatus**](docs/ModerationApi.md#postSetCommentSpamStatus) | **POST** /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} |
*ModerationApi* | [**postSetCommentText**](docs/ModerationApi.md#postSetCommentText) | **POST** /auth/my-account/moderate-comments/set-comment-text/{commentId} |
*ModerationApi* | [**postUnFlagComment**](docs/ModerationApi.md#postUnFlagComment) | **POST** /auth/my-account/moderate-comments/un-flag-comment/{commentId} |
*ModerationApi* | [**postVote**](docs/ModerationApi.md#postVote) | **POST** /auth/my-account/moderate-comments/vote/{commentId} |
*ModerationApi* | [**putAwardBadge**](docs/ModerationApi.md#putAwardBadge) | **PUT** /auth/my-account/moderate-comments/award-badge |
*ModerationApi* | [**putCloseThread**](docs/ModerationApi.md#putCloseThread) | **PUT** /auth/my-account/moderate-comments/close-thread |
*ModerationApi* | [**putRemoveBadge**](docs/ModerationApi.md#putRemoveBadge) | **PUT** /auth/my-account/moderate-comments/remove-badge |
*ModerationApi* | [**putReopenThread**](docs/ModerationApi.md#putReopenThread) | **PUT** /auth/my-account/moderate-comments/reopen-thread |
*ModerationApi* | [**setTrustFactor**](docs/ModerationApi.md#setTrustFactor) | **PUT** /auth/my-account/moderate-comments/set-trust-factor |
*ModerationApi* | [**deleteModerationVote**](docs/ModerationApi.md#deleteModerationVote) | **DELETE** /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} |
*ModerationApi* | [**getApiComments**](docs/ModerationApi.md#getApiComments) | **GET** /auth/my-account/moderate-comments/mod_api/api/comments |
*ModerationApi* | [**getApiExportStatus**](docs/ModerationApi.md#getApiExportStatus) | **GET** /auth/my-account/moderate-comments/mod_api/api/export/status |
*ModerationApi* | [**getApiIds**](docs/ModerationApi.md#getApiIds) | **GET** /auth/my-account/moderate-comments/mod_api/api/ids |
*ModerationApi* | [**getBanUsersFromComment**](docs/ModerationApi.md#getBanUsersFromComment) | **GET** /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} |
*ModerationApi* | [**getCommentBanStatus**](docs/ModerationApi.md#getCommentBanStatus) | **GET** /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} |
*ModerationApi* | [**getCommentChildren**](docs/ModerationApi.md#getCommentChildren) | **GET** /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} |
*ModerationApi* | [**getCount**](docs/ModerationApi.md#getCount) | **GET** /auth/my-account/moderate-comments/mod_api/count |
*ModerationApi* | [**getCounts**](docs/ModerationApi.md#getCounts) | **GET** /auth/my-account/moderate-comments/banned-users/mod_api/counts |
*ModerationApi* | [**getLogs**](docs/ModerationApi.md#getLogs) | **GET** /auth/my-account/moderate-comments/mod_api/logs/{commentId} |
*ModerationApi* | [**getManualBadges**](docs/ModerationApi.md#getManualBadges) | **GET** /auth/my-account/moderate-comments/mod_api/get-manual-badges |
*ModerationApi* | [**getManualBadgesForUser**](docs/ModerationApi.md#getManualBadgesForUser) | **GET** /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user |
*ModerationApi* | [**getModerationComment**](docs/ModerationApi.md#getModerationComment) | **GET** /auth/my-account/moderate-comments/mod_api/comment/{commentId} |
*ModerationApi* | [**getModerationCommentText**](docs/ModerationApi.md#getModerationCommentText) | **GET** /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} |
*ModerationApi* | [**getPreBanSummary**](docs/ModerationApi.md#getPreBanSummary) | **GET** /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} |
*ModerationApi* | [**getSearchCommentsSummary**](docs/ModerationApi.md#getSearchCommentsSummary) | **GET** /auth/my-account/moderate-comments/mod_api/search/comments/summary |
*ModerationApi* | [**getSearchPages**](docs/ModerationApi.md#getSearchPages) | **GET** /auth/my-account/moderate-comments/mod_api/search/pages |
*ModerationApi* | [**getSearchSites**](docs/ModerationApi.md#getSearchSites) | **GET** /auth/my-account/moderate-comments/mod_api/search/sites |
*ModerationApi* | [**getSearchSuggest**](docs/ModerationApi.md#getSearchSuggest) | **GET** /auth/my-account/moderate-comments/mod_api/search/suggest |
*ModerationApi* | [**getSearchUsers**](docs/ModerationApi.md#getSearchUsers) | **GET** /auth/my-account/moderate-comments/mod_api/search/users |
*ModerationApi* | [**getTrustFactor**](docs/ModerationApi.md#getTrustFactor) | **GET** /auth/my-account/moderate-comments/mod_api/get-trust-factor |
*ModerationApi* | [**getUserBanPreference**](docs/ModerationApi.md#getUserBanPreference) | **GET** /auth/my-account/moderate-comments/mod_api/user-ban-preference |
*ModerationApi* | [**getUserInternalProfile**](docs/ModerationApi.md#getUserInternalProfile) | **GET** /auth/my-account/moderate-comments/mod_api/get-user-internal-profile |
*ModerationApi* | [**postAdjustCommentVotes**](docs/ModerationApi.md#postAdjustCommentVotes) | **POST** /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} |
*ModerationApi* | [**postApiExport**](docs/ModerationApi.md#postApiExport) | **POST** /auth/my-account/moderate-comments/mod_api/api/export |
*ModerationApi* | [**postBanUserFromComment**](docs/ModerationApi.md#postBanUserFromComment) | **POST** /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} |
*ModerationApi* | [**postBanUserUndo**](docs/ModerationApi.md#postBanUserUndo) | **POST** /auth/my-account/moderate-comments/mod_api/ban-user/undo |
*ModerationApi* | [**postBulkPreBanSummary**](docs/ModerationApi.md#postBulkPreBanSummary) | **POST** /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary |
*ModerationApi* | [**postCommentsByIds**](docs/ModerationApi.md#postCommentsByIds) | **POST** /auth/my-account/moderate-comments/mod_api/comments-by-ids |
*ModerationApi* | [**postFlagComment**](docs/ModerationApi.md#postFlagComment) | **POST** /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} |
*ModerationApi* | [**postRemoveComment**](docs/ModerationApi.md#postRemoveComment) | **POST** /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} |
*ModerationApi* | [**postRestoreDeletedComment**](docs/ModerationApi.md#postRestoreDeletedComment) | **POST** /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} |
*ModerationApi* | [**postSetCommentApprovalStatus**](docs/ModerationApi.md#postSetCommentApprovalStatus) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} |
*ModerationApi* | [**postSetCommentReviewStatus**](docs/ModerationApi.md#postSetCommentReviewStatus) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} |
*ModerationApi* | [**postSetCommentSpamStatus**](docs/ModerationApi.md#postSetCommentSpamStatus) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} |
*ModerationApi* | [**postSetCommentText**](docs/ModerationApi.md#postSetCommentText) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} |
*ModerationApi* | [**postUnFlagComment**](docs/ModerationApi.md#postUnFlagComment) | **POST** /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} |
*ModerationApi* | [**postVote**](docs/ModerationApi.md#postVote) | **POST** /auth/my-account/moderate-comments/mod_api/vote/{commentId} |
*ModerationApi* | [**putAwardBadge**](docs/ModerationApi.md#putAwardBadge) | **PUT** /auth/my-account/moderate-comments/mod_api/award-badge |
*ModerationApi* | [**putCloseThread**](docs/ModerationApi.md#putCloseThread) | **PUT** /auth/my-account/moderate-comments/mod_api/close-thread |
*ModerationApi* | [**putRemoveBadge**](docs/ModerationApi.md#putRemoveBadge) | **PUT** /auth/my-account/moderate-comments/mod_api/remove-badge |
*ModerationApi* | [**putReopenThread**](docs/ModerationApi.md#putReopenThread) | **PUT** /auth/my-account/moderate-comments/mod_api/reopen-thread |
*ModerationApi* | [**setTrustFactor**](docs/ModerationApi.md#setTrustFactor) | **PUT** /auth/my-account/moderate-comments/mod_api/set-trust-factor |
*PublicApi* | [**blockFromCommentPublic**](docs/PublicApi.md#blockFromCommentPublic) | **POST** /block-from-comment/{commentId} |
*PublicApi* | [**checkedCommentsForBlocked**](docs/PublicApi.md#checkedCommentsForBlocked) | **GET** /check-blocked-comments |
*PublicApi* | [**createCommentPublic**](docs/PublicApi.md#createCommentPublic) | **POST** /comments/{tenantId} |
Expand Down Expand Up @@ -595,7 +595,7 @@ Class | Method | HTTP request | Description
- [PatchPageAPIResponse](docs/PatchPageAPIResponse.md)
- [PatchSSOUserAPIResponse](docs/PatchSSOUserAPIResponse.md)
- [PendingCommentToSyncOutbound](docs/PendingCommentToSyncOutbound.md)
- [PostRemoveCommentResponse](docs/PostRemoveCommentResponse.md)
- [PostRemoveCommentApiResponse](docs/PostRemoveCommentApiResponse.md)
- [PreBanSummary](docs/PreBanSummary.md)
- [PubSubComment](docs/PubSubComment.md)
- [PubSubCommentBase](docs/PubSubCommentBase.md)
Expand Down
Loading
Loading