Skip to content

feat: v3.2.0, API changes #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisdengso merged 1 commit into from
Oct 26, 2026
Merged

feat: v3.2.0, API changes #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
  •  
  •  
  •  
1,199 changes: 881 additions & 318 deletions .speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ generation:
generateNewTests: true
skipResponseBodyAssertions: false
ruby:
version: 3.1.1
version: 3.2.0
additionalDependencies:
development: {}
runtime: {}
Expand Down
11,459 changes: 6,824 additions & 4,635 deletions .speakeasy/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

136 changes: 136 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,141 @@
# Changelog

## 3.2.0 (2026-10-26)

Full Changelog: [v3.1.1...v3.2.0](https://github.com/moderation-api/sdk-ruby/compare/v3.1.1...v3.2.0)

### ⚠ Breaking changes

- `GET /authors`: removed the enum value `reportCount` from the `query` request parameter `sortBy`
- `GET /queue/{id}`: the response property `queue/description` became nullable for the status `200`
- `GET /queue/{id}`: removed the required property `queue/filter` from the response with the `200` status
- `GET /queue/{id}/items`: added `subschema #1, subschema #2` to the `data/items/content` response property `anyOf` list for the response status `200`
- `GET /queue/{id}/items`: the response property `data/items/authorId` became nullable for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/contentType` became nullable for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/conversationId` became nullable for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/language` became nullable for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/labels/items/flagged` became optional for the status `200`
- `GET /queue/{id}/items`: the `data/items/content` response's property `type` changed from `string` to `any` for status `200`
- `POST /queue/{id}/items/{itemId}/resolve`: removed the request body
- `POST /queue/{id}/items/{itemId}/unresolve`: removed the request body
- `GET /queue/{id}/stats`: the response property `topReviewers/items/name` became nullable for the status `200`
- `GET /queue/{id}/stats`: the response property `topReviewers/items/userId` became nullable for the status `200`
- `GET /queue/{id}/stats`: removed the required property `actionStats` from the response with the `200` status
- `GET /queue/{id}/stats`: removed the required property `reviewStats/averageTimeToReview` from the response with the `200` status
- `GET /queue/{id}/stats`: removed the required property `topReviewers/items/averageTimePerReview` from the response with the `200` status
- `GET /queue/{id}/stats`: removed the required property `topReviewers/items/topActions` from the response with the `200` status
- `GET /queue/{id}/stats`: removed the required property `trends/flaggedContentTrends` from the response with the `200` status

### API changes

- `GET /actions`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /actions`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /actions`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /actions/execute`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /actions/execute`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /actions/{actionId}/execute`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /actions/{actionId}/execute`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `DELETE /actions/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /actions/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /actions/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /actions/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /actions/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /actions/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /auth`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /auth`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /auth`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /authors`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /authors`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /authors`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /authors/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /authors/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /authors/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /authors/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /authors/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /authors/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `DELETE /channels/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /channels/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /channels/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /channels/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /channels/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /channels/{id}/duplicate`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /channels/{id}/duplicate`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /moderate`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /moderate/image`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /moderate/text`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /projects`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /projects/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /projects/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /projects/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /projects/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /projects/{id}/duplicate`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /projects/{id}/duplicate`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /projects/{projectId}/channels`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /projects/{projectId}/channels`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /projects/{projectId}/channels`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /queue/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /queue/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /queue/{id}/items`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /queue/{id}/items`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /queue/{id}/items/{itemId}/resolve`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /queue/{id}/items/{itemId}/unresolve`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /queue/{id}/stats`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /queue/{id}/stats`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /webhooks`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /webhooks/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /webhooks/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /webhooks/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /webhooks/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /wordlist`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /wordlist`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /wordlist/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /wordlist/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `PUT /wordlist/{id}`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `PUT /wordlist/{id}`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /wordlist/{id}/embedding-status`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `GET /wordlist/{id}/embedding-status`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `DELETE /wordlist/{id}/words`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `DELETE /wordlist/{id}/words`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `POST /wordlist/{id}/words`: added the new `project_name_ambiguous` enum value to the `code` response property for the response status `400`
- `POST /wordlist/{id}/words`: added the new `queue_item_not_found` enum value to the `code` response property for the response status `404`
- `GET /authors`: deleted the `query` request parameter `contentTypes`
- `GET /queue/{id}/items`: deleted the `query` request parameter `sortDirection`
- `GET /queue/{id}/items`: deleted the `query` request parameter `sortField`
- a breaking change was detected but the version is still `1.1.0`
- `GET /analytics/authors`: endpoint added
- `GET /analytics/automation`: endpoint added
- `GET /analytics/channels`: endpoint added
- `GET /analytics/policies`: endpoint added
- `GET /analytics/summary`: endpoint added
- `GET /analytics/volumes`: endpoint added
- `POST /feedback`: endpoint added
- `POST /projects/{id}/api-keys`: endpoint added
- `GET /queue`: endpoint added
- `GET /queue/{id}`: the `queue/resolvedItemsCount` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}`: the `queue/totalItemsCount` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}`: the `queue/unresolvedItemsCount` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}`: added the required property `queue/isDefault` to the response with the `200` status
- `GET /queue/{id}/items`: added the new optional `query` request parameter `sort`
- `GET /queue/{id}/items`: added the optional property `data/items/labels/items/manual` to the response with the `200` status
- `GET /queue/{id}/items`: added the optional property `data/items/labels/items/matches` to the response with the `200` status
- `GET /queue/{id}/items`: added the optional property `data/items/labels/items/shadow_flagged` to the response with the `200` status
- `GET /queue/{id}/items`: removed the optional property `data/items/actions` from the response with the `200` status
- `GET /queue/{id}/items`: the response property `data/items/authorId` became required for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/contentType` became required for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/conversationId` became required for the status `200`
- `GET /queue/{id}/items`: the response property `data/items/language` became required for the status `200`
- `GET /queue/{id}/items`: added the required property `data/items/contentId` to the response with the `200` status
- `GET /queue/{id}/items`: added the required property `data/items/severity` to the response with the `200` status
- `POST /queue/{id}/items/resolve`: endpoint added
- `POST /queue/{id}/items/{itemId}/resolve`: removed the optional property `comment` from the response with the `200` status
- `POST /queue/{id}/items/{itemId}/unresolve`: the `status` response property for the response status `200` was restricted to a list of enum values
- `GET /queue/{id}/stats`: removed the optional property `topReviewers/items/accuracyScore` from the response with the `200` status
- `GET /queue/{id}/stats`: the `reviewStats/totalPending` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}/stats`: the `reviewStats/totalReviewed` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}/stats`: the `topReviewers/items/reviewCount` response's property `type` was narrowed from `number` to `integer` for status `200`
- `GET /queue/{id}/stats`: the `trends/dailyReviewCounts/items/count` response's property `type` was narrowed from `number` to `integer` for status `200`
- `POST /wordlist`: endpoint added

## 3.1.1 (2026-10-22)

Full Changelog: [v3.1.0...v3.1.1](https://github.com/moderation-api/sdk-ruby/compare/v3.1.0...v3.1.1)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
moderation_api (3.1.1)
moderation_api (3.2.0)
faraday
faraday-multipart
faraday-retry
Expand Down
Loading
Loading