moderation_api 3.1.1 → 3.2.0

data/lib/moderation_api/models/components/{status.rb → publicauthor_status.rb}

@@ -6,8 +6,8 @@
 module ModerationApi
   module Models
     module Components
-      # Status - Current author status
-      class Status
+      # PublicAuthorStatus - Current author status
+      class PublicAuthorStatus
         include ::Crystalline::Enum
         enums do
           ENABLED = new("enabled")

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

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

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

@@ -0,0 +1,55 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class Queue
+        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}}
+        )
+        # Whether this is the default queue of the project.
+        field(
+          :is_default,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("isDefault"), 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, is_default: T::Boolean, description: T.nilable(::String)).void }
+        def initialize(id:, name:, is_default:, description: nil)
+          @id = id
+          @name = name
+          @is_default = is_default
+          @description = description
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @name == other.name
+          return false unless @is_default == other.is_default
+          return false unless @description == other.description
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::Queue
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::Queue
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def is_default
+  end
+
+  def is_default=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+end

data/lib/moderation_api/models/{operations/listqueueitems_data.rb → components/queueitem.rb}

@@ -5,120 +5,158 @@
 
 module ModerationApi
   module Models
-    module Operations
+    module Components
 
-      class ListQueueItemsData
+      class QueueItem
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # Content ID
+        # The item ID. Use it to resolve or unresolve the item in this queue.
         field :id, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("id"), required: true}}
-        # The content to be moderated
+        # Your content ID, as you sent it to `POST /moderate`.
         field(
-          :content,
+          :content_id,
           ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("content"), required: true}}
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("contentId"), required: true}}
         )
-
+        # The moderation labels of the content.
         field(
           :labels,
-          Crystalline::Array.new(Models::Operations::ListQueueItemsLabel),
+          Crystalline::Array.new(Models::Components::Label),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("labels"), required: true}}
         )
-        # Whether the item is flagged by any label
+        # Whether moderation flagged the content.
         field(
           :flagged,
           Crystalline::Boolean.new,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
         )
-        # Status of the item
+        # `pending` waits for review. `resolved` is reviewed.
         field(
           :status,
-          Models::Operations::ListQueueItemsStatus,
+          Models::Components::QueueItemStatus,
           {
             'format_json': {
               'letter_case': ::ModerationApi::Utils.field_name("status"),
               required: true,
-              'decoder': ::ModerationApi::Utils.open_enum_from_string(Models::Operations::ListQueueItemsStatus, false)
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(Models::Components::QueueItemStatus, false)
             }
           }
         )
-        # Unix timestamp of when the item was created
+        # When the content was submitted, as Unix time in milliseconds.
         field(
           :timestamp,
           ::Float,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("timestamp"), required: true}}
         )
-        # Content language
+        # The submitted content.
+        field(
+          :content,
+          Crystalline::Nilable.new(
+            Crystalline::DiscriminatedUnion.new(
+              "type",
+              {
+                "text" => Models::Components::QueueItemText,
+                "image" => Models::Components::QueueItemImage,
+                "video" => Models::Components::QueueItemVideo,
+                "audio" => Models::Components::QueueItemAudio,
+                "object" => Models::Components::QueueItemObject
+              }
+            )
+          ),
+          {
+            'format_json': {'letter_case': ::ModerationApi::Utils.field_name("content"), required: true},
+            'discriminator': "type",
+            'discriminator_mapping': {
+              "text" => Models::Components::QueueItemText,
+              "image" => Models::Components::QueueItemImage,
+              "video" => Models::Components::QueueItemVideo,
+              "audio" => Models::Components::QueueItemAudio,
+              "object" => Models::Components::QueueItemObject
+            }
+          }
+        )
+        # Severity score from 0 to 1, if available.
+        field(
+          :severity,
+          Crystalline::Nilable.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("severity"), required: true}}
+        )
+        # Detected ISO language code.
         field(
           :language,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("language")}}
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("language"), required: true}}
         )
-        # Conversation ID
+        # Conversation ID, if any.
         field(
           :conversation_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("conversationId")}}
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("conversationId"), required: true}}
         )
-        # Author ID
+        # Your author ID, if any.
         field(
           :author_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("authorId")}}
-        )
-        # Action IDs taken on this item
-        field(
-          :actions,
-          Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::ListQueueItemsAction)),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("actions")}}
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("authorId"), required: true}}
         )
-        # Type of the content object
+        # Content type, for example `message` or `profile`.
         field(
           :content_type,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("contentType")}}
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("contentType"), required: true}}
         )
 
         sig {
           params(
             id: ::String,
-            content: ::String,
-            labels: T::Array[Models::Operations::ListQueueItemsLabel],
+            content_id: ::String,
+            labels: T::Array[Models::Components::Label],
             flagged: T::Boolean,
-            status: Models::Operations::ListQueueItemsStatus,
+            status: Models::Components::QueueItemStatus,
             timestamp: ::Float,
+            content: T.nilable(
+              T.any(
+                Models::Components::QueueItemText,
+                Models::Components::QueueItemImage,
+                Models::Components::QueueItemVideo,
+                Models::Components::QueueItemAudio,
+                Models::Components::QueueItemObject
+              )
+            ),
+            severity: T.nilable(::Float),
             language: T.nilable(::String),
             conversation_id: T.nilable(::String),
             author_id: T.nilable(::String),
-            actions: T.nilable(T::Array[Models::Operations::ListQueueItemsAction]),
             content_type: T.nilable(::String)
           )
             .void
         }
         def initialize(
           id:,
-          content:,
+          content_id:,
           labels:,
           flagged:,
           status:,
           timestamp:,
+          content: nil,
+          severity: nil,
           language: nil,
           conversation_id: nil,
           author_id: nil,
-          actions: nil,
           content_type: nil
         )
           @id = id
-          @content = content
+          @content_id = content_id
           @labels = labels
           @flagged = flagged
           @status = status
           @timestamp = timestamp
+          @content = content
+          @severity = severity
           @language = language
           @conversation_id = conversation_id
           @author_id = author_id
-          @actions = actions
           @content_type = content_type
         end
 
@@ -126,15 +164,16 @@ module ModerationApi
         def ==(other)
           return false unless other.is_a?(self.class)
           return false unless @id == other.id
-          return false unless @content == other.content
+          return false unless @content_id == other.content_id
           return false unless @labels == other.labels
           return false unless @flagged == other.flagged
           return false unless @status == other.status
           return false unless @timestamp == other.timestamp
+          return false unless @content == other.content
+          return false unless @severity == other.severity
           return false unless @language == other.language
           return false unless @conversation_id == other.conversation_id
           return false unless @author_id == other.author_id
-          return false unless @actions == other.actions
           return false unless @content_type == other.content_type
           true
         end

data/lib/moderation_api/models/{operations/listqueueitems_data.rbi → components/queueitem.rbi}

@@ -1,21 +1,21 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::ListQueueItemsData
+class ModerationApi::Models::Components::QueueItem
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::ListQueueItemsData
+class ModerationApi::Models::Components::QueueItem
   def id
   end
 
   def id=(str_)
   end
 
-  def content
+  def content_id
   end
 
-  def content=(str_)
+  def content_id=(str_)
   end
 
   def labels
@@ -42,6 +42,18 @@ class ModerationApi::Models::Operations::ListQueueItemsData
   def timestamp=(str_)
   end
 
+  def content
+  end
+
+  def content=(str_)
+  end
+
+  def severity
+  end
+
+  def severity=(str_)
+  end
+
   def language
   end
 
@@ -60,12 +72,6 @@ class ModerationApi::Models::Operations::ListQueueItemsData
   def author_id=(str_)
   end
 
-  def actions
-  end
-
-  def actions=(str_)
-  end
-
   def content_type
   end
 

data/lib/moderation_api/models/components/queueitem_audio.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
+      # Audio
+      class QueueItemAudio
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The URL of the audio 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: "audio")
+          @url = url
+          unless type == "audio"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "audio"
+        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_audio.rbi

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

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

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

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

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

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

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class QueueItemContent
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class QueueItemContentLeaf
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/moderation_api/models/components/queueitem_content_leaf_audio.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
+      # Audio
+      class QueueItemContentLeafAudio
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The URL of the audio 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: "audio")
+          @url = url
+          unless type == "audio"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "audio"
+        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_content_leaf_audio.rbi

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