moderation_api 3.1.1 → 3.2.0

data/lib/moderation_api/models/operations/source.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Source - Where the feedback was written: MCP server, agent skill, CLI or API.
+      class Source < T::Enum
+        enums do
+          MCP = new("mcp")
+          SKILL = new("skill")
+          CLI = new("cli")
+          API = new("api")
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/{isflagged.rbi → source.rbi}

@@ -1,9 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::IsFlagged
+class ModerationApi::Models::Operations::Source
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::IsFlagged
+class ModerationApi::Models::Operations::Source
 end

data/lib/moderation_api/models/operations/{author.rb → submitcontent_author.rb}

@@ -7,7 +7,7 @@ module ModerationApi
   module Models
     module Operations
 
-      class Author
+      class SubmitContentAuthor
         extend T::Sig
         include Crystalline::MetadataFields
 

data/lib/moderation_api/models/operations/{author.rbi → submitcontent_author.rbi}

@@ -1,11 +1,11 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::Author
+class ModerationApi::Models::Operations::SubmitContentAuthor
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::Author
+class ModerationApi::Models::Operations::SubmitContentAuthor
   def id
   end
 

data/lib/moderation_api/models/operations/{policy_response.rb → submitcontent_policy_response.rb}

@@ -7,7 +7,7 @@ module ModerationApi
   module Models
     module Operations
       # Policy output schema.
-      class PolicyResponse
+      class SubmitContentPolicyResponse
         extend T::Sig
         include Crystalline::MetadataFields
 

data/lib/moderation_api/models/operations/submitcontent_policy_response.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::SubmitContentPolicyResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::SubmitContentPolicyResponse
+end

data/lib/moderation_api/models/operations/submitcontent_request.rb

@@ -12,7 +12,7 @@ module ModerationApi
         include Crystalline::MetadataFields
 
         field :body, Models::Operations::SubmitContentRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

data/lib/moderation_api/models/operations/submitcontent_requestbody.rb

@@ -86,7 +86,7 @@ module ModerationApi
           Crystalline::Nilable.new(Models::Operations::ClientAction),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("clientAction")}}
         )
-        # Do not store the content. The content won't enter the review queue
+        # Process the content without saving it on our servers. The item is still created and appears in the review queue, analytics and author history with its moderation results, but its content is empty, so reviewers cannot see what was submitted.
         field(
           :do_not_store,
           Crystalline::Nilable.new(Crystalline::Boolean.new),

data/lib/moderation_api/models/operations/submitcontent_responsebody.rb

@@ -70,7 +70,7 @@ module ModerationApi
         # The author of the content if your account has authors enabled. Requires you to send authorId when submitting content.
         field(
           :author,
-          Crystalline::Nilable.new(Models::Operations::Author),
+          Crystalline::Nilable.new(Models::Operations::SubmitContentAuthor),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("author"), required: true}}
         )
         # What your casebook — the record of your past moderation decisions — found for this content, or null when it had nothing close enough to say, when the matching cases disagreed, or when casebook lookups are not switched on for this channel. Reports what the casebook found; whether it decided the outcome is shown in `recommendation`, where a higher-priority rule may have settled the item first.
@@ -103,7 +103,7 @@ module ModerationApi
               )
             ],
             meta: Models::Operations::Meta,
-            author: T.nilable(Models::Operations::Author),
+            author: T.nilable(Models::Operations::SubmitContentAuthor),
             casebook: T.nilable(Models::Operations::Casebook),
             errors: T.nilable(T::Array[Models::Operations::Error])
           )

data/lib/moderation_api/models/operations/topreviewer.rb

@@ -11,72 +11,38 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # ID of the reviewer
-        field(
-          :user_id,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("userId"), required: true}}
-        )
-        # Name of the reviewer
-        field(
-          :name,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
-        )
-        # Number of items reviewed
+        # Number of items the reviewer resolved in the period.
         field(
           :review_count,
-          ::Float,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewCount"), required: true}}
         )
-        # Average review time in milliseconds
-        field(
-          :average_time_per_review,
-          ::Float,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("averageTimePerReview"), required: true}}
-        )
-        # Most common actions taken by this reviewer
+        # The user ID of the reviewer. `null` for items resolved with an API key.
         field(
-          :top_actions,
-          Crystalline::Array.new(Models::Operations::TopAction),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("topActions"), required: true}}
+          :user_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("userId"), required: true}}
         )
-        # Optional accuracy score based on review quality metrics
+        # The name of the reviewer.
         field(
-          :accuracy_score,
-          Crystalline::Nilable.new(::Float),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("accuracyScore")}}
+          :name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
         )
 
-        sig {
-          params(
-            user_id: ::String,
-            name: ::String,
-            review_count: ::Float,
-            average_time_per_review: ::Float,
-            top_actions: T::Array[Models::Operations::TopAction],
-            accuracy_score: T.nilable(::Float)
-          )
-            .void
-        }
-        def initialize(user_id:, name:, review_count:, average_time_per_review:, top_actions:, accuracy_score: nil)
+        sig { params(review_count: ::Integer, user_id: T.nilable(::String), name: T.nilable(::String)).void }
+        def initialize(review_count:, user_id: nil, name: nil)
+          @review_count = review_count
           @user_id = user_id
           @name = name
-          @review_count = review_count
-          @average_time_per_review = average_time_per_review
-          @top_actions = top_actions
-          @accuracy_score = accuracy_score
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
         def ==(other)
           return false unless other.is_a?(self.class)
+          return false unless @review_count == other.review_count
           return false unless @user_id == other.user_id
           return false unless @name == other.name
-          return false unless @review_count == other.review_count
-          return false unless @average_time_per_review == other.average_time_per_review
-          return false unless @top_actions == other.top_actions
-          return false unless @accuracy_score == other.accuracy_score
           true
         end
       end

data/lib/moderation_api/models/operations/topreviewer.rbi

@@ -6,39 +6,21 @@ class ModerationApi::Models::Operations::TopReviewer
 end
 
 class ModerationApi::Models::Operations::TopReviewer
-  def user_id
-  end
-
-  def user_id=(str_)
-  end
-
-  def name
-  end
-
-  def name=(str_)
-  end
-
   def review_count
   end
 
   def review_count=(str_)
   end
 
-  def average_time_per_review
-  end
-
-  def average_time_per_review=(str_)
-  end
-
-  def top_actions
+  def user_id
   end
 
-  def top_actions=(str_)
+  def user_id=(str_)
   end
 
-  def accuracy_score
+  def name
   end
 
-  def accuracy_score=(str_)
+  def name=(str_)
   end
 end

data/lib/moderation_api/models/operations/totals.rb

@@ -0,0 +1,122 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Request counts for the window. A flagged request has one recommendation: allow, reject or review.
+      class Totals
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Requests received. Every request counts, also repeats and edits of the same content.
+        field(
+          :requests,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("requests"), required: true}}
+        )
+        # Requests that were flagged.
+        field(
+          :flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
+        )
+        # The share of requests that were flagged: flagged / requests. 0 when there were no requests.
+        field(
+          :flag_rate,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagRate"), required: true}}
+        )
+        # Requests with the recommendation "allow". Includes content that was not flagged.
+        field(
+          :allowed,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("allowed"), required: true}}
+        )
+        # Requests with the recommendation "reject". All of them were flagged.
+        field(
+          :rejected,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("rejected"), required: true}}
+        )
+        # Requests with the recommendation "review". This counts requests, not the deduplicated items in the review queue.
+        field(
+          :sent_to_review,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("sentToReview"), required: true}}
+        )
+        # Flagged requests that were settled without human review: rejected plus flaggedButAllowed.
+        field(
+          :handled_automatically,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("handledAutomatically"), required: true}}
+        )
+        # Flagged requests that were allowed without human review.
+        field(
+          :flagged_but_allowed,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flaggedButAllowed"), required: true}}
+        )
+        # Distinct authors that sent content in the window. Approximate.
+        field(
+          :distinct_authors,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("distinctAuthors"), required: true}}
+        )
+
+        sig {
+          params(
+            requests: ::Integer,
+            flagged: ::Integer,
+            flag_rate: ::Float,
+            allowed: ::Integer,
+            rejected: ::Integer,
+            sent_to_review: ::Integer,
+            handled_automatically: ::Integer,
+            flagged_but_allowed: ::Integer,
+            distinct_authors: ::Integer
+          )
+            .void
+        }
+        def initialize(
+          requests:,
+          flagged:,
+          flag_rate:,
+          allowed:,
+          rejected:,
+          sent_to_review:,
+          handled_automatically:,
+          flagged_but_allowed:,
+          distinct_authors:
+        )
+          @requests = requests
+          @flagged = flagged
+          @flag_rate = flag_rate
+          @allowed = allowed
+          @rejected = rejected
+          @sent_to_review = sent_to_review
+          @handled_automatically = handled_automatically
+          @flagged_but_allowed = flagged_but_allowed
+          @distinct_authors = distinct_authors
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @requests == other.requests
+          return false unless @flagged == other.flagged
+          return false unless @flag_rate == other.flag_rate
+          return false unless @allowed == other.allowed
+          return false unless @rejected == other.rejected
+          return false unless @sent_to_review == other.sent_to_review
+          return false unless @handled_automatically == other.handled_automatically
+          return false unless @flagged_but_allowed == other.flagged_but_allowed
+          return false unless @distinct_authors == other.distinct_authors
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/totals.rbi

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::Totals
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::Totals
+  def requests
+  end
+
+  def requests=(str_)
+  end
+
+  def flagged
+  end
+
+  def flagged=(str_)
+  end
+
+  def flag_rate
+  end
+
+  def flag_rate=(str_)
+  end
+
+  def allowed
+  end
+
+  def allowed=(str_)
+  end
+
+  def rejected
+  end
+
+  def rejected=(str_)
+  end
+
+  def sent_to_review
+  end
+
+  def sent_to_review=(str_)
+  end
+
+  def handled_automatically
+  end
+
+  def handled_automatically=(str_)
+  end
+
+  def flagged_but_allowed
+  end
+
+  def flagged_but_allowed=(str_)
+  end
+
+  def distinct_authors
+  end
+
+  def distinct_authors=(str_)
+  end
+end

data/lib/moderation_api/models/operations/trends.rb

@@ -11,35 +11,22 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
+        # Resolved items per day. Days with no reviews are left out.
         field(
           :daily_review_counts,
           Crystalline::Array.new(Models::Operations::DailyReviewCount),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("dailyReviewCounts"), required: true}}
         )
 
-        field(
-          :flagged_content_trends,
-          Crystalline::Array.new(Models::Operations::FlaggedContentTrend),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flaggedContentTrends"), required: true}}
-        )
-
-        sig {
-          params(
-            daily_review_counts: T::Array[Models::Operations::DailyReviewCount],
-            flagged_content_trends: T::Array[Models::Operations::FlaggedContentTrend]
-          )
-            .void
-        }
-        def initialize(daily_review_counts:, flagged_content_trends:)
+        sig { params(daily_review_counts: T::Array[Models::Operations::DailyReviewCount]).void }
+        def initialize(daily_review_counts:)
           @daily_review_counts = daily_review_counts
-          @flagged_content_trends = flagged_content_trends
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
         def ==(other)
           return false unless other.is_a?(self.class)
           return false unless @daily_review_counts == other.daily_review_counts
-          return false unless @flagged_content_trends == other.flagged_content_trends
           true
         end
       end

data/lib/moderation_api/models/operations/trends.rbi

@@ -11,10 +11,4 @@ class ModerationApi::Models::Operations::Trends
 
   def daily_review_counts=(str_)
   end
-
-  def flagged_content_trends
-  end
-
-  def flagged_content_trends=(str_)
-  end
 end

data/lib/moderation_api/models/operations/unresolvequeueitem_request.rb

@@ -11,32 +11,21 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The queue ID
+        # The queue ID.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The item ID to unresolve
+        # The item ID to unresolve.
         field :item_id, ::String, {'path_param': {'field_name': "itemId", 'style': "simple", 'explode': false}}
-
-        field :body, Models::Operations::UnresolveQueueItemRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),
           {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
         )
 
-        sig {
-          params(
-            id: ::String,
-            item_id: ::String,
-            body: Models::Operations::UnresolveQueueItemRequestBody,
-            project_id: T.nilable(::String)
-          )
-            .void
-        }
-        def initialize(id:, item_id:, body:, project_id: nil)
+        sig { params(id: ::String, item_id: ::String, project_id: T.nilable(::String)).void }
+        def initialize(id:, item_id:, project_id: nil)
           @id = id
           @item_id = item_id
-          @body = body
           @project_id = project_id
         end
 
@@ -45,7 +34,6 @@ module ModerationApi
           return false unless other.is_a?(self.class)
           return false unless @id == other.id
           return false unless @item_id == other.item_id
-          return false unless @body == other.body
           return false unless @project_id == other.project_id
           true
         end

data/lib/moderation_api/models/operations/unresolvequeueitem_request.rbi

@@ -18,12 +18,6 @@ class ModerationApi::Models::Operations::UnresolveQueueItemRequest
   def item_id=(str_)
   end
 
-  def body
-  end
-
-  def body=(str_)
-  end
-
   def project_id
   end
 

data/lib/moderation_api/models/operations/unresolvequeueitem_responsebody.rb

@@ -16,20 +16,32 @@ module ModerationApi
           Crystalline::Boolean.new,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("success"), required: true}}
         )
-        # New status of the item
+        # `pending` waits for review. `resolved` is reviewed.
         field(
           :status,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("status"), required: true}}
+          Models::Operations::UnresolveQueueItemStatus,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("status"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::UnresolveQueueItemStatus,
+                false
+              )
+            }
+          }
         )
-        # Timestamp when the item was unresolved
+        # When the item was unresolved (ISO 8601).
         field(
           :unresolved_at,
           ::String,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("unresolvedAt"), required: true}}
         )
 
-        sig { params(success: T::Boolean, status: ::String, unresolved_at: ::String).void }
+        sig {
+          params(success: T::Boolean, status: Models::Operations::UnresolveQueueItemStatus, unresolved_at: ::String)
+            .void
+        }
         def initialize(success:, status:, unresolved_at:)
           @success = success
           @status = status

data/lib/moderation_api/models/operations/{listqueueitems_status.rb → unresolvequeueitem_status.rb}

@@ -6,8 +6,8 @@
 module ModerationApi
   module Models
     module Operations
-      # ListQueueItemsStatus - Status of the item
-      class ListQueueItemsStatus
+      # UnresolveQueueItemStatus - `pending` waits for review. `resolved` is reviewed.
+      class UnresolveQueueItemStatus
         include ::Crystalline::Enum
         enums do
           PENDING = new("pending")

data/lib/moderation_api/models/operations/unresolvequeueitem_status.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::UnresolveQueueItemStatus
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::UnresolveQueueItemStatus
+end

data/lib/moderation_api/models/operations/updateaction_request.rb

@@ -15,7 +15,7 @@ module ModerationApi
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field :body, Models::Operations::UpdateActionRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

data/lib/moderation_api/models/operations/updateauthor_request.rb

@@ -15,7 +15,7 @@ module ModerationApi
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field :body, Models::Operations::UpdateAuthorRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

data/lib/moderation_api/models/operations/updatewebhook_request.rb

@@ -15,7 +15,7 @@ module ModerationApi
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field :body, Models::Operations::UpdateWebhookRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

data/lib/moderation_api/models/operations/updatewordlist_request.rb

@@ -15,7 +15,7 @@ module ModerationApi
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field :body, Models::Operations::UpdateWordlistRequestBody, {'request': {'media_type': "application/json"}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

data/lib/moderation_api/models/operations/updatewordlist_requestbody.rb

@@ -29,7 +29,7 @@ module ModerationApi
           Crystalline::Nilable.new(::String),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
         )
-        # New words for the wordlist. Replace the existing words with these new ones. Duplicate words will be ignored.
+        # New words for the wordlist. Replace the existing words with these new ones. Words are converted to lowercase. Duplicate and empty words are ignored. Maximum 5000 words.
         field(
           :words,
           Crystalline::Nilable.new(Crystalline::Array.new(::String)),