moderation_api 3.1.1 → 3.2.0

data/lib/moderation_api/models/components/queueitem_signals.rbi

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::QueueItemSignals
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::QueueItemSignals
+  def has_suspicious_characters
+  end
+
+  def has_suspicious_characters=(str_)
+  end
+
+  def is_link_shortener
+  end
+
+  def is_link_shortener=(str_)
+  end
+
+  def is_reported
+  end
+
+  def is_reported=(str_)
+  end
+
+  def brand_impersonation
+  end
+
+  def brand_impersonation=(str_)
+  end
+
+  def domain_age_days
+  end
+
+  def domain_age_days=(str_)
+  end
+
+  def has_email_setup
+  end
+
+  def has_email_setup=(str_)
+  end
+
+  def redirect_count
+  end
+
+  def redirect_count=(str_)
+  end
+
+  def final_url
+  end
+
+  def final_url=(str_)
+  end
+
+  def bot_protection
+  end
+
+  def bot_protection=(str_)
+  end
+end

data/lib/moderation_api/models/{operations/casebookagreement.rb → components/queueitem_status.rb}

@@ -5,14 +5,13 @@
 
 module ModerationApi
   module Models
-    module Operations
-
-      class CasebookAgreement
+    module Components
+      # QueueItemStatus - `pending` waits for review. `resolved` is reviewed.
+      class QueueItemStatus
         include ::Crystalline::Enum
         enums do
-          ALL = new("ALL")
-          OVERRULED = new("OVERRULED")
-          AGREED = new("AGREED")
+          PENDING = new("pending")
+          RESOLVED = new("resolved")
         end
 
         open!

data/lib/moderation_api/models/components/queueitem_status.rbi

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

data/lib/moderation_api/models/components/queueitem_text.rb

@@ -0,0 +1,47 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Text
+      class QueueItemText
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The content text
+        field(
+          :text,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("text"), required: true}}
+        )
+
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+
+        sig { params(text: ::String, type: ::String).void }
+        def initialize(text:, type: "text")
+          @text = text
+          unless type == "text"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "text"
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @text == other.text
+          return false unless @type == other.type
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/queueitem_text.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::QueueItemText
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::QueueItemText
+  def text
+  end
+
+  def text=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+end

data/lib/moderation_api/models/components/queueitem_video.rb

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Video
+      class QueueItemVideo
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A public URL of the video content
+        field :url, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("url"), required: true}}
+
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+
+        sig { params(url: ::String, type: ::String).void }
+        def initialize(url:, type: "video")
+          @url = url
+          unless type == "video"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "video"
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @url == other.url
+          return false unless @type == other.type
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/queueitem_video.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::QueueItemVideo
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::QueueItemVideo
+  def url
+  end
+
+  def url=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+end

data/lib/moderation_api/models/{operations/queue.rb → components/queuewithcounts.rb}

@@ -5,78 +5,79 @@
 
 module ModerationApi
   module Models
-    module Operations
+    module Components
 
-      class Queue
+      class QueueWithCounts
         extend T::Sig
         include Crystalline::MetadataFields
 
+        # The queue ID.
         field :id, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("id"), required: true}}
-
+        # The queue name.
         field(
           :name,
           ::String,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
         )
-
-        field(
-          :description,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description"), required: true}}
-        )
-
+        # Whether this is the default queue of the project.
         field(
-          :filter,
-          Models::Operations::Filter,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("filter"), required: true}}
+          :is_default,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("isDefault"), required: true}}
         )
-
+        # Number of items that wait for review.
         field(
           :unresolved_items_count,
-          ::Float,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("unresolvedItemsCount"), required: true}}
         )
-
+        # Number of items that are resolved.
         field(
           :resolved_items_count,
-          ::Float,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("resolvedItemsCount"), required: true}}
         )
-
+        # Number of items in the queue, resolved and unresolved.
         field(
           :total_items_count,
-          ::Float,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("totalItemsCount"), required: true}}
         )
+        # The queue description.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description"), required: true}}
+        )
 
         sig {
           params(
             id: ::String,
             name: ::String,
-            description: ::String,
-            filter: Models::Operations::Filter,
-            unresolved_items_count: ::Float,
-            resolved_items_count: ::Float,
-            total_items_count: ::Float
+            is_default: T::Boolean,
+            unresolved_items_count: ::Integer,
+            resolved_items_count: ::Integer,
+            total_items_count: ::Integer,
+            description: T.nilable(::String)
           )
             .void
         }
         def initialize(
           id:,
           name:,
-          description:,
-          filter:,
+          is_default:,
           unresolved_items_count:,
           resolved_items_count:,
-          total_items_count:
+          total_items_count:,
+          description: nil
         )
           @id = id
           @name = name
-          @description = description
-          @filter = filter
+          @is_default = is_default
           @unresolved_items_count = unresolved_items_count
           @resolved_items_count = resolved_items_count
           @total_items_count = total_items_count
+          @description = description
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -84,11 +85,11 @@ module ModerationApi
           return false unless other.is_a?(self.class)
           return false unless @id == other.id
           return false unless @name == other.name
-          return false unless @description == other.description
-          return false unless @filter == other.filter
+          return false unless @is_default == other.is_default
           return false unless @unresolved_items_count == other.unresolved_items_count
           return false unless @resolved_items_count == other.resolved_items_count
           return false unless @total_items_count == other.total_items_count
+          return false unless @description == other.description
           true
         end
       end

data/lib/moderation_api/models/{operations/queue.rbi → components/queuewithcounts.rbi}

@@ -1,11 +1,11 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::Queue
+class ModerationApi::Models::Components::QueueWithCounts
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::Queue
+class ModerationApi::Models::Components::QueueWithCounts
   def id
   end
 
@@ -18,16 +18,10 @@ class ModerationApi::Models::Operations::Queue
   def name=(str_)
   end
 
-  def description
-  end
-
-  def description=(str_)
-  end
-
-  def filter
+  def is_default
   end
 
-  def filter=(str_)
+  def is_default=(str_)
   end
 
   def unresolved_items_count
@@ -47,4 +41,10 @@ class ModerationApi::Models::Operations::Queue
 
   def total_items_count=(str_)
   end
+
+  def description
+  end
+
+  def description=(str_)
+  end
 end

data/lib/moderation_api/models/components.rb

@@ -16,6 +16,7 @@ module ModerationApi
       autoload :Pagination, "moderation_api/models/components/pagination.rb"
       autoload :PermissionDeniedErrorCode, "moderation_api/models/components/permissiondeniederror_code.rb"
       autoload :Project, "moderation_api/models/components/project.rb"
+      autoload :ProjectApiKey, "moderation_api/models/components/projectapikey.rb"
       autoload :ProjectWithKey, "moderation_api/models/components/projectwithkey.rb"
       autoload(
         :ProjectWithKeyGlobalFlaggingMode,
@@ -23,16 +24,35 @@ module ModerationApi
       )
       autoload :ProjectGlobalFlaggingMode, "moderation_api/models/components/project_globalflaggingmode.rb"
       autoload :PublicAuthor, "moderation_api/models/components/publicauthor.rb"
+      autoload :PublicAuthorStatus, "moderation_api/models/components/publicauthor_status.rb"
+      autoload :Queue, "moderation_api/models/components/queue.rb"
+      autoload :QueueItem, "moderation_api/models/components/queueitem.rb"
+      autoload :QueueItemAudio, "moderation_api/models/components/queueitem_audio.rb"
+      autoload :QueueItemContentLeaf, "moderation_api/models/components/queueitem_content_leaf.rb"
+      autoload :QueueItemContentLeafAudio, "moderation_api/models/components/queueitem_content_leaf_audio.rb"
+      autoload :QueueItemContentLeafImage, "moderation_api/models/components/queueitem_content_leaf_image.rb"
+      autoload :QueueItemContentLeafText, "moderation_api/models/components/queueitem_content_leaf_text.rb"
+      autoload :QueueItemContentLeafVideo, "moderation_api/models/components/queueitem_content_leaf_video.rb"
+      autoload :QueueItemImage, "moderation_api/models/components/queueitem_image.rb"
+      autoload :QueueItemObject, "moderation_api/models/components/queueitem_object.rb"
+      autoload :QueueItemText, "moderation_api/models/components/queueitem_text.rb"
+      autoload :QueueItemVideo, "moderation_api/models/components/queueitem_video.rb"
+      autoload :QueueItemBrandImpersonation, "moderation_api/models/components/queueitem_brand_impersonation.rb"
+      autoload :QueueItemContent, "moderation_api/models/components/queueitem_content.rb"
+      autoload :QueueItemMatch, "moderation_api/models/components/queueitem_match.rb"
+      autoload :QueueItemSignals, "moderation_api/models/components/queueitem_signals.rb"
+      autoload :QueueItemStatus, "moderation_api/models/components/queueitem_status.rb"
+      autoload :QueueWithCounts, "moderation_api/models/components/queuewithcounts.rb"
       autoload :RateLimitErrorCode, "moderation_api/models/components/ratelimiterror_code.rb"
       autoload :Security, "moderation_api/models/components/security.rb"
       autoload :Block, "moderation_api/models/components/block.rb"
       autoload :ContentType, "moderation_api/models/components/contenttype.rb"
       autoload :FlaggingMode, "moderation_api/models/components/flaggingmode.rb"
+      autoload :Label, "moderation_api/models/components/label.rb"
       autoload :Metadata, "moderation_api/models/components/metadata.rb"
       autoload :Metrics, "moderation_api/models/components/metrics.rb"
       autoload :Path, "moderation_api/models/components/path.rb"
       autoload :RiskEvaluation, "moderation_api/models/components/risk_evaluation.rb"
-      autoload :Status, "moderation_api/models/components/status.rb"
       autoload :TranscriptionQuality, "moderation_api/models/components/transcriptionquality.rb"
       autoload :TrustLevel, "moderation_api/models/components/trust_level.rb"
     end

data/lib/moderation_api/models/errors/badrequesterror.rb

@@ -14,7 +14,8 @@ module ModerationApi
         # Exactly what went wrong. Stable; safe to branch on. New codes may be added.
         #
         # - `invalid_request`: A parameter is invalid. `message` says which one.
-        # - `project_id_required`: An organization key called a project endpoint without naming the project in `Project-Id`, and the organization has more than one project.
+        # - `project_id_required`: An organization key called a project endpoint without naming the project in `Project-Id`, and the key reaches more than one project. `message` lists the projects it reaches.
+        # - `project_name_ambiguous`: The name in `Project-Id` fits more than one project the key reaches. `message` lists them; name the project by ID instead.
         # - `validation_failed`: The request body does not match the schema. `issues` lists each problem with its `path`.
         field(
           :code,

data/lib/moderation_api/models/errors/notfounderror.rb

@@ -17,6 +17,7 @@ module ModerationApi
         # - `action_not_found`: The action does not exist.
         # - `author_not_found`: The author does not exist.
         # - `queue_not_found`: The review queue does not exist.
+        # - `queue_item_not_found`: The queue item does not exist in the project.
         # - `wordlist_not_found`: The wordlist does not exist.
         # - `webhook_not_found`: The webhook does not exist.
         # - `project_not_found`: The project does not exist.

data/lib/moderation_api/models/operations/{getqueue_recommendationaction.rb → action_response.rb}

@@ -6,8 +6,8 @@
 module ModerationApi
   module Models
     module Operations
-
-      class GetQueueRecommendationAction
+      # ActionResponse - The action to take based on the recommendation
+      class ActionResponse
         include ::Crystalline::Enum
         enums do
           REVIEW = new("review")

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

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

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

@@ -15,7 +15,7 @@ module ModerationApi
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field :body, Models::Operations::AddWordlistWordsRequestBody, {'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/{checkstatus.rb → bucket.rb}

@@ -6,13 +6,12 @@
 module ModerationApi
   module Models
     module Operations
-
-      class CheckStatus
+      # Bucket - The size of each entry in `volumes`.
+      class Bucket
         include ::Crystalline::Enum
         enums do
-          ALL = new("all")
-          CHECKED = new("checked")
-          UNCHECKED = new("unchecked")
+          HOUR = new("hour")
+          DAY = new("day")
         end
 
         open!

data/lib/moderation_api/models/{components/status.rbi → operations/bucket.rbi}

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

data/lib/moderation_api/models/operations/{listqueueitems_action.rb → channel.rb}

@@ -7,53 +7,44 @@ module ModerationApi
   module Models
     module Operations
 
-      class ListQueueItemsAction
+      class Channel
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # Action ID
+        # The channel ID.
         field :id, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("id"), required: true}}
-        # Action name
+        # The channel name.
         field(
           :name,
           ::String,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
         )
-        # Unix timestamp of when the action was taken
+        # Requests received in this channel.
         field(
-          :timestamp,
-          ::Float,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("timestamp"), required: true}}
+          :requests,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("requests"), required: true}}
         )
-        # Action comment
+        # Requests flagged in this channel.
         field(
-          :comment,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("comment")}}
+          :flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
         )
-        # Moderator userID
+        # The share of requests in this channel that were flagged: flagged / requests.
         field(
-          :reviewer,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewer")}}
+          :flag_rate,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagRate"), required: true}}
         )
 
-        sig {
-          params(
-            id: ::String,
-            name: ::String,
-            timestamp: ::Float,
-            comment: T.nilable(::String),
-            reviewer: T.nilable(::String)
-          )
-            .void
-        }
-        def initialize(id:, name:, timestamp:, comment: nil, reviewer: nil)
+        sig { params(id: ::String, name: ::String, requests: ::Integer, flagged: ::Integer, flag_rate: ::Float).void }
+        def initialize(id:, name:, requests:, flagged:, flag_rate:)
           @id = id
           @name = name
-          @timestamp = timestamp
-          @comment = comment
-          @reviewer = reviewer
+          @requests = requests
+          @flagged = flagged
+          @flag_rate = flag_rate
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -61,9 +52,9 @@ module ModerationApi
           return false unless other.is_a?(self.class)
           return false unless @id == other.id
           return false unless @name == other.name
-          return false unless @timestamp == other.timestamp
-          return false unless @comment == other.comment
-          return false unless @reviewer == other.reviewer
+          return false unless @requests == other.requests
+          return false unless @flagged == other.flagged
+          return false unless @flag_rate == other.flag_rate
           true
         end
       end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::Channel
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::Channel
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def requests
+  end
+
+  def requests=(str_)
+  end
+
+  def flagged
+  end
+
+  def flagged=(str_)
+  end
+
+  def flag_rate
+  end
+
+  def flag_rate=(str_)
+  end
+end

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

@@ -40,7 +40,7 @@ module ModerationApi
 
         field(
           :labels,
-          Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::SubmitContentLabel)),
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::Label)),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("labels")}}
         )
         # Optional structured data produced by the policy. For face detection: { count, faces: [{ confidence, gender, age }] }.
@@ -57,7 +57,7 @@ module ModerationApi
             flagged: T::Boolean,
             type: ::String,
             flagged_fields: T.nilable(T::Array[::String]),
-            labels: T.nilable(T::Array[Models::Operations::SubmitContentLabel]),
+            labels: T.nilable(T::Array[Models::Operations::Label]),
             data: T.nilable(T::Hash[Symbol, ::Object])
           )
             .void