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
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fastcomments-sdk"
version = "2.0.0"
version = "3.0.0"
authors = ["FastComments <support@fastcomments.com>"]
description = "Official FastComments Rust SDK (Typed API Client & Utilities)"
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The FastComments Rust SDK consists of several modules:
- Three API clients covering all FastComments methods:
- `default_api` (**DefaultApi**) - API-key-authenticated methods for server-side use
- `public_api` (**PublicApi**) - public, no-API-key methods that are safe to call from browsers and mobile apps
- `moderation_api` (**ModerationApi**) - methods backing the moderator dashboard, including comment moderation (list, count, search, logs, export), moderation actions (remove/restore, flag, set review/spam/approval status, votes, reopen/close thread), bans (ban from a comment, undo, pre-ban summaries, ban status/preferences, banned-user counts), and badges & trust (award/remove badges, manual badges, get/set trust factor, user internal profile). Every Moderation method accepts an `sso` parameter so the call can be made on behalf of an SSO-authenticated moderator.
- `moderation_api` (**ModerationApi**) - an extensive suite of live and fast moderation APIs. Every Moderation method accepts an `sso` parameter and can authenticate via SSO or a FastComments.com session cookie.
- Full async/await support with tokio
- See [client/README.md](client/README.md) for detailed API documentation

Expand Down
4 changes: 2 additions & 2 deletions client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,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 @@ -633,7 +633,7 @@ src/models/patch_domain_config_response.rs
src/models/patch_page_api_response.rs
src/models/patch_sso_user_api_response.rs
src/models/pending_comment_to_sync_outbound.rs
src/models/post_remove_comment_response.rs
src/models/post_remove_comment_api_response.rs
src/models/pre_ban_summary.rs
src/models/pub_sub_comment.rs
src/models/pub_sub_comment_base.rs
Expand Down
90 changes: 45 additions & 45 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 0.0.0
- Package version: 1.3.1
- Package version: 3.0.0
- Generator version: 7.23.0-SNAPSHOT
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

Expand Down Expand Up @@ -140,49 +140,49 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**update_tenant_package**](docs/DefaultApi.md#update_tenant_package) | **PATCH** /api/v1/tenant-packages/{id} |
*DefaultApi* | [**update_tenant_user**](docs/DefaultApi.md#update_tenant_user) | **PATCH** /api/v1/tenant-users/{id} |
*DefaultApi* | [**update_user_badge**](docs/DefaultApi.md#update_user_badge) | **PUT** /api/v1/user-badges/{id} |
*ModerationApi* | [**delete_moderation_vote**](docs/ModerationApi.md#delete_moderation_vote) | **DELETE** /auth/my-account/moderate-comments/vote/{commentId}/{voteId} |
*ModerationApi* | [**get_api_comments**](docs/ModerationApi.md#get_api_comments) | **GET** /auth/my-account/moderate-comments/api/comments |
*ModerationApi* | [**get_api_export_status**](docs/ModerationApi.md#get_api_export_status) | **GET** /auth/my-account/moderate-comments/api/export/status |
*ModerationApi* | [**get_api_ids**](docs/ModerationApi.md#get_api_ids) | **GET** /auth/my-account/moderate-comments/api/ids |
*ModerationApi* | [**get_ban_users_from_comment**](docs/ModerationApi.md#get_ban_users_from_comment) | **GET** /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} |
*ModerationApi* | [**get_comment_ban_status**](docs/ModerationApi.md#get_comment_ban_status) | **GET** /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} |
*ModerationApi* | [**get_comment_children**](docs/ModerationApi.md#get_comment_children) | **GET** /auth/my-account/moderate-comments/comment-children/{commentId} |
*ModerationApi* | [**get_count**](docs/ModerationApi.md#get_count) | **GET** /auth/my-account/moderate-comments/count |
*ModerationApi* | [**get_counts**](docs/ModerationApi.md#get_counts) | **GET** /auth/my-account/moderate-comments/banned-users/counts |
*ModerationApi* | [**get_logs**](docs/ModerationApi.md#get_logs) | **GET** /auth/my-account/moderate-comments/logs/{commentId} |
*ModerationApi* | [**get_manual_badges**](docs/ModerationApi.md#get_manual_badges) | **GET** /auth/my-account/moderate-comments/get-manual-badges |
*ModerationApi* | [**get_manual_badges_for_user**](docs/ModerationApi.md#get_manual_badges_for_user) | **GET** /auth/my-account/moderate-comments/get-manual-badges-for-user |
*ModerationApi* | [**get_moderation_comment**](docs/ModerationApi.md#get_moderation_comment) | **GET** /auth/my-account/moderate-comments/comment/{commentId} |
*ModerationApi* | [**get_moderation_comment_text**](docs/ModerationApi.md#get_moderation_comment_text) | **GET** /auth/my-account/moderate-comments/get-comment-text/{commentId} |
*ModerationApi* | [**get_pre_ban_summary**](docs/ModerationApi.md#get_pre_ban_summary) | **GET** /auth/my-account/moderate-comments/pre-ban-summary/{commentId} |
*ModerationApi* | [**get_search_comments_summary**](docs/ModerationApi.md#get_search_comments_summary) | **GET** /auth/my-account/moderate-comments/search/comments/summary |
*ModerationApi* | [**get_search_pages**](docs/ModerationApi.md#get_search_pages) | **GET** /auth/my-account/moderate-comments/search/pages |
*ModerationApi* | [**get_search_sites**](docs/ModerationApi.md#get_search_sites) | **GET** /auth/my-account/moderate-comments/search/sites |
*ModerationApi* | [**get_search_suggest**](docs/ModerationApi.md#get_search_suggest) | **GET** /auth/my-account/moderate-comments/search/suggest |
*ModerationApi* | [**get_search_users**](docs/ModerationApi.md#get_search_users) | **GET** /auth/my-account/moderate-comments/search/users |
*ModerationApi* | [**get_trust_factor**](docs/ModerationApi.md#get_trust_factor) | **GET** /auth/my-account/moderate-comments/get-trust-factor |
*ModerationApi* | [**get_user_ban_preference**](docs/ModerationApi.md#get_user_ban_preference) | **GET** /auth/my-account/moderate-comments/user-ban-preference |
*ModerationApi* | [**get_user_internal_profile**](docs/ModerationApi.md#get_user_internal_profile) | **GET** /auth/my-account/moderate-comments/get-user-internal-profile |
*ModerationApi* | [**post_adjust_comment_votes**](docs/ModerationApi.md#post_adjust_comment_votes) | **POST** /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} |
*ModerationApi* | [**post_api_export**](docs/ModerationApi.md#post_api_export) | **POST** /auth/my-account/moderate-comments/api/export |
*ModerationApi* | [**post_ban_user_from_comment**](docs/ModerationApi.md#post_ban_user_from_comment) | **POST** /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} |
*ModerationApi* | [**post_ban_user_undo**](docs/ModerationApi.md#post_ban_user_undo) | **POST** /auth/my-account/moderate-comments/ban-user/undo |
*ModerationApi* | [**post_bulk_pre_ban_summary**](docs/ModerationApi.md#post_bulk_pre_ban_summary) | **POST** /auth/my-account/moderate-comments/bulk-pre-ban-summary |
*ModerationApi* | [**post_comments_by_ids**](docs/ModerationApi.md#post_comments_by_ids) | **POST** /auth/my-account/moderate-comments/comments-by-ids |
*ModerationApi* | [**post_flag_comment**](docs/ModerationApi.md#post_flag_comment) | **POST** /auth/my-account/moderate-comments/flag-comment/{commentId} |
*ModerationApi* | [**post_remove_comment**](docs/ModerationApi.md#post_remove_comment) | **POST** /auth/my-account/moderate-comments/remove-comment/{commentId} |
*ModerationApi* | [**post_restore_deleted_comment**](docs/ModerationApi.md#post_restore_deleted_comment) | **POST** /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} |
*ModerationApi* | [**post_set_comment_approval_status**](docs/ModerationApi.md#post_set_comment_approval_status) | **POST** /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} |
*ModerationApi* | [**post_set_comment_review_status**](docs/ModerationApi.md#post_set_comment_review_status) | **POST** /auth/my-account/moderate-comments/set-comment-review-status/{commentId} |
*ModerationApi* | [**post_set_comment_spam_status**](docs/ModerationApi.md#post_set_comment_spam_status) | **POST** /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} |
*ModerationApi* | [**post_set_comment_text**](docs/ModerationApi.md#post_set_comment_text) | **POST** /auth/my-account/moderate-comments/set-comment-text/{commentId} |
*ModerationApi* | [**post_un_flag_comment**](docs/ModerationApi.md#post_un_flag_comment) | **POST** /auth/my-account/moderate-comments/un-flag-comment/{commentId} |
*ModerationApi* | [**post_vote**](docs/ModerationApi.md#post_vote) | **POST** /auth/my-account/moderate-comments/vote/{commentId} |
*ModerationApi* | [**put_award_badge**](docs/ModerationApi.md#put_award_badge) | **PUT** /auth/my-account/moderate-comments/award-badge |
*ModerationApi* | [**put_close_thread**](docs/ModerationApi.md#put_close_thread) | **PUT** /auth/my-account/moderate-comments/close-thread |
*ModerationApi* | [**put_remove_badge**](docs/ModerationApi.md#put_remove_badge) | **PUT** /auth/my-account/moderate-comments/remove-badge |
*ModerationApi* | [**put_reopen_thread**](docs/ModerationApi.md#put_reopen_thread) | **PUT** /auth/my-account/moderate-comments/reopen-thread |
*ModerationApi* | [**set_trust_factor**](docs/ModerationApi.md#set_trust_factor) | **PUT** /auth/my-account/moderate-comments/set-trust-factor |
*ModerationApi* | [**delete_moderation_vote**](docs/ModerationApi.md#delete_moderation_vote) | **DELETE** /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} |
*ModerationApi* | [**get_api_comments**](docs/ModerationApi.md#get_api_comments) | **GET** /auth/my-account/moderate-comments/mod_api/api/comments |
*ModerationApi* | [**get_api_export_status**](docs/ModerationApi.md#get_api_export_status) | **GET** /auth/my-account/moderate-comments/mod_api/api/export/status |
*ModerationApi* | [**get_api_ids**](docs/ModerationApi.md#get_api_ids) | **GET** /auth/my-account/moderate-comments/mod_api/api/ids |
*ModerationApi* | [**get_ban_users_from_comment**](docs/ModerationApi.md#get_ban_users_from_comment) | **GET** /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} |
*ModerationApi* | [**get_comment_ban_status**](docs/ModerationApi.md#get_comment_ban_status) | **GET** /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} |
*ModerationApi* | [**get_comment_children**](docs/ModerationApi.md#get_comment_children) | **GET** /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} |
*ModerationApi* | [**get_count**](docs/ModerationApi.md#get_count) | **GET** /auth/my-account/moderate-comments/mod_api/count |
*ModerationApi* | [**get_counts**](docs/ModerationApi.md#get_counts) | **GET** /auth/my-account/moderate-comments/banned-users/mod_api/counts |
*ModerationApi* | [**get_logs**](docs/ModerationApi.md#get_logs) | **GET** /auth/my-account/moderate-comments/mod_api/logs/{commentId} |
*ModerationApi* | [**get_manual_badges**](docs/ModerationApi.md#get_manual_badges) | **GET** /auth/my-account/moderate-comments/mod_api/get-manual-badges |
*ModerationApi* | [**get_manual_badges_for_user**](docs/ModerationApi.md#get_manual_badges_for_user) | **GET** /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user |
*ModerationApi* | [**get_moderation_comment**](docs/ModerationApi.md#get_moderation_comment) | **GET** /auth/my-account/moderate-comments/mod_api/comment/{commentId} |
*ModerationApi* | [**get_moderation_comment_text**](docs/ModerationApi.md#get_moderation_comment_text) | **GET** /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} |
*ModerationApi* | [**get_pre_ban_summary**](docs/ModerationApi.md#get_pre_ban_summary) | **GET** /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} |
*ModerationApi* | [**get_search_comments_summary**](docs/ModerationApi.md#get_search_comments_summary) | **GET** /auth/my-account/moderate-comments/mod_api/search/comments/summary |
*ModerationApi* | [**get_search_pages**](docs/ModerationApi.md#get_search_pages) | **GET** /auth/my-account/moderate-comments/mod_api/search/pages |
*ModerationApi* | [**get_search_sites**](docs/ModerationApi.md#get_search_sites) | **GET** /auth/my-account/moderate-comments/mod_api/search/sites |
*ModerationApi* | [**get_search_suggest**](docs/ModerationApi.md#get_search_suggest) | **GET** /auth/my-account/moderate-comments/mod_api/search/suggest |
*ModerationApi* | [**get_search_users**](docs/ModerationApi.md#get_search_users) | **GET** /auth/my-account/moderate-comments/mod_api/search/users |
*ModerationApi* | [**get_trust_factor**](docs/ModerationApi.md#get_trust_factor) | **GET** /auth/my-account/moderate-comments/mod_api/get-trust-factor |
*ModerationApi* | [**get_user_ban_preference**](docs/ModerationApi.md#get_user_ban_preference) | **GET** /auth/my-account/moderate-comments/mod_api/user-ban-preference |
*ModerationApi* | [**get_user_internal_profile**](docs/ModerationApi.md#get_user_internal_profile) | **GET** /auth/my-account/moderate-comments/mod_api/get-user-internal-profile |
*ModerationApi* | [**post_adjust_comment_votes**](docs/ModerationApi.md#post_adjust_comment_votes) | **POST** /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} |
*ModerationApi* | [**post_api_export**](docs/ModerationApi.md#post_api_export) | **POST** /auth/my-account/moderate-comments/mod_api/api/export |
*ModerationApi* | [**post_ban_user_from_comment**](docs/ModerationApi.md#post_ban_user_from_comment) | **POST** /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} |
*ModerationApi* | [**post_ban_user_undo**](docs/ModerationApi.md#post_ban_user_undo) | **POST** /auth/my-account/moderate-comments/mod_api/ban-user/undo |
*ModerationApi* | [**post_bulk_pre_ban_summary**](docs/ModerationApi.md#post_bulk_pre_ban_summary) | **POST** /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary |
*ModerationApi* | [**post_comments_by_ids**](docs/ModerationApi.md#post_comments_by_ids) | **POST** /auth/my-account/moderate-comments/mod_api/comments-by-ids |
*ModerationApi* | [**post_flag_comment**](docs/ModerationApi.md#post_flag_comment) | **POST** /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} |
*ModerationApi* | [**post_remove_comment**](docs/ModerationApi.md#post_remove_comment) | **POST** /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} |
*ModerationApi* | [**post_restore_deleted_comment**](docs/ModerationApi.md#post_restore_deleted_comment) | **POST** /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} |
*ModerationApi* | [**post_set_comment_approval_status**](docs/ModerationApi.md#post_set_comment_approval_status) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} |
*ModerationApi* | [**post_set_comment_review_status**](docs/ModerationApi.md#post_set_comment_review_status) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} |
*ModerationApi* | [**post_set_comment_spam_status**](docs/ModerationApi.md#post_set_comment_spam_status) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} |
*ModerationApi* | [**post_set_comment_text**](docs/ModerationApi.md#post_set_comment_text) | **POST** /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} |
*ModerationApi* | [**post_un_flag_comment**](docs/ModerationApi.md#post_un_flag_comment) | **POST** /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} |
*ModerationApi* | [**post_vote**](docs/ModerationApi.md#post_vote) | **POST** /auth/my-account/moderate-comments/mod_api/vote/{commentId} |
*ModerationApi* | [**put_award_badge**](docs/ModerationApi.md#put_award_badge) | **PUT** /auth/my-account/moderate-comments/mod_api/award-badge |
*ModerationApi* | [**put_close_thread**](docs/ModerationApi.md#put_close_thread) | **PUT** /auth/my-account/moderate-comments/mod_api/close-thread |
*ModerationApi* | [**put_remove_badge**](docs/ModerationApi.md#put_remove_badge) | **PUT** /auth/my-account/moderate-comments/mod_api/remove-badge |
*ModerationApi* | [**put_reopen_thread**](docs/ModerationApi.md#put_reopen_thread) | **PUT** /auth/my-account/moderate-comments/mod_api/reopen-thread |
*ModerationApi* | [**set_trust_factor**](docs/ModerationApi.md#set_trust_factor) | **PUT** /auth/my-account/moderate-comments/mod_api/set-trust-factor |
*PublicApi* | [**block_from_comment_public**](docs/PublicApi.md#block_from_comment_public) | **POST** /block-from-comment/{commentId} |
*PublicApi* | [**checked_comments_for_blocked**](docs/PublicApi.md#checked_comments_for_blocked) | **GET** /check-blocked-comments |
*PublicApi* | [**create_comment_public**](docs/PublicApi.md#create_comment_public) | **POST** /comments/{tenantId} |
Expand Down Expand Up @@ -498,7 +498,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
12 changes: 6 additions & 6 deletions client/docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Name | Type | Description | Required | Notes

Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant_id** | Option<**String**> | | |
**tenant_id** | **String** | | [required] |
**create_hash_tag_body** | Option<[**CreateHashTagBody**](CreateHashTagBody.md)> | | |

### Return type
Expand Down Expand Up @@ -189,7 +189,7 @@ Name | Type | Description | Required | Notes

Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant_id** | Option<**String**> | | |
**tenant_id** | **String** | | [required] |
**bulk_create_hash_tags_body** | Option<[**BulkCreateHashTagsBody**](BulkCreateHashTagsBody.md)> | | |

### Return type
Expand Down Expand Up @@ -939,16 +939,16 @@ Name | Type | Description | Required | Notes

## delete_hash_tag

> models::ApiEmptyResponse delete_hash_tag(tag, tenant_id, delete_hash_tag_request_body)
> models::ApiEmptyResponse delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)


### Parameters


Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant_id** | **String** | | [required] |
**tag** | **String** | | [required] |
**tenant_id** | Option<**String**> | | |
**delete_hash_tag_request_body** | Option<[**DeleteHashTagRequestBody**](DeleteHashTagRequestBody.md)> | | |

### Return type
Expand Down Expand Up @@ -2783,16 +2783,16 @@ Name | Type | Description | Required | Notes

## patch_hash_tag

> models::UpdateHashTagResponse patch_hash_tag(tag, tenant_id, update_hash_tag_body)
> models::UpdateHashTagResponse patch_hash_tag(tenant_id, tag, update_hash_tag_body)


### Parameters


Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tenant_id** | **String** | | [required] |
**tag** | **String** | | [required] |
**tenant_id** | Option<**String**> | | |
**update_hash_tag_body** | Option<[**UpdateHashTagBody**](UpdateHashTagBody.md)> | | |

### Return type
Expand Down
Loading
Loading