moderation_api 3.1.1 → 3.2.0

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

@@ -0,0 +1,54 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Image
+      class QueueItemContentLeafImage
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+        # A public URL of the image content. Either url or data must be provided.
+        field(
+          :url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("url")}}
+        )
+        # Base64-encoded image data. Either url or data must be provided. Note: base64 images are not stored and will not appear in the review queue.
+        field(
+          :data,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("data")}}
+        )
+
+        sig { params(type: ::String, url: T.nilable(::String), data: T.nilable(::String)).void }
+        def initialize(type: "image", url: nil, data: nil)
+          unless type == "image"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "image"
+          @url = url
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @url == other.url
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/moderation_api/models/components/queueitem_content_leaf_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 QueueItemContentLeafText
+        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_content_leaf_text.rbi

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

data/lib/moderation_api/models/components/queueitem_content_leaf_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 QueueItemContentLeafVideo
+        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_content_leaf_video.rbi

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

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

@@ -0,0 +1,54 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Image
+      class QueueItemImage
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+        # A public URL of the image content. Either url or data must be provided.
+        field(
+          :url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("url")}}
+        )
+        # Base64-encoded image data. Either url or data must be provided. Note: base64 images are not stored and will not appear in the review queue.
+        field(
+          :data,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("data")}}
+        )
+
+        sig { params(type: ::String, url: T.nilable(::String), data: T.nilable(::String)).void }
+        def initialize(type: "image", url: nil, data: nil)
+          unless type == "image"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "image"
+          @url = url
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @url == other.url
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/moderation_api/models/components/queueitem_match.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 Components
+
+      class QueueItemMatch
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The matched substring
+        field(
+          :match,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("match"), required: true}}
+        )
+        # Match confidence between 0 and 1
+        field(
+          :probability,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("probability"), required: true}}
+        )
+        # [start, end] character offsets in the source text
+        field(
+          :span,
+          Crystalline::Array.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("span"), required: true}}
+        )
+
+        field(
+          :reasons,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reasons")}}
+        )
+
+        field(
+          :signals,
+          Crystalline::Nilable.new(Models::Components::QueueItemSignals),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("signals")}}
+        )
+
+        field(
+          :entity_type,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("entity_type")}}
+        )
+
+        field(
+          :scripts,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("scripts")}}
+        )
+
+        field(
+          :skeleton,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("skeleton")}}
+        )
+
+        field(
+          :mask,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("mask")}}
+        )
+
+        sig {
+          params(
+            match: ::String,
+            probability: ::Float,
+            span: T::Array[::Float],
+            reasons: T.nilable(T::Array[::String]),
+            signals: T.nilable(Models::Components::QueueItemSignals),
+            entity_type: T.nilable(::String),
+            scripts: T.nilable(T::Array[::String]),
+            skeleton: T.nilable(::String),
+            mask: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          match:,
+          probability:,
+          span:,
+          reasons: nil,
+          signals: nil,
+          entity_type: nil,
+          scripts: nil,
+          skeleton: nil,
+          mask: nil
+        )
+          @match = match
+          @probability = probability
+          @span = span
+          @reasons = reasons
+          @signals = signals
+          @entity_type = entity_type
+          @scripts = scripts
+          @skeleton = skeleton
+          @mask = mask
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @match == other.match
+          return false unless @probability == other.probability
+          return false unless @span == other.span
+          return false unless @reasons == other.reasons
+          return false unless @signals == other.signals
+          return false unless @entity_type == other.entity_type
+          return false unless @scripts == other.scripts
+          return false unless @skeleton == other.skeleton
+          return false unless @mask == other.mask
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::QueueItemMatch
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::QueueItemMatch
+  def match
+  end
+
+  def match=(str_)
+  end
+
+  def probability
+  end
+
+  def probability=(str_)
+  end
+
+  def span
+  end
+
+  def span=(str_)
+  end
+
+  def reasons
+  end
+
+  def reasons=(str_)
+  end
+
+  def signals
+  end
+
+  def signals=(str_)
+  end
+
+  def entity_type
+  end
+
+  def entity_type=(str_)
+  end
+
+  def scripts
+  end
+
+  def scripts=(str_)
+  end
+
+  def skeleton
+  end
+
+  def skeleton=(str_)
+  end
+
+  def mask
+  end
+
+  def mask=(str_)
+  end
+end

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

@@ -0,0 +1,72 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Object
+      class QueueItemObject
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Values in the object. Can be mixed content types.
+        field(
+          :data,
+          Crystalline::Hash.new(
+            Symbol,
+            Crystalline::DiscriminatedUnion.new(
+              "type",
+              {
+                "text" => Models::Components::QueueItemContentLeafText,
+                "image" => Models::Components::QueueItemContentLeafImage,
+                "video" => Models::Components::QueueItemContentLeafVideo,
+                "audio" => Models::Components::QueueItemContentLeafAudio
+              }
+            )
+          ),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("data"), required: true}}
+        )
+
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+
+        sig {
+          params(
+            data: T::Hash[
+              Symbol,
+              T.any(
+                Models::Components::QueueItemContentLeafText,
+                Models::Components::QueueItemContentLeafImage,
+                Models::Components::QueueItemContentLeafVideo,
+                Models::Components::QueueItemContentLeafAudio
+              )
+            ],
+            type: ::String
+          )
+            .void
+        }
+        def initialize(data:, type: "object")
+          @data = data
+          unless type == "object"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "object"
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @data == other.data
+          return false unless @type == other.type
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,126 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class QueueItemSignals
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :has_suspicious_characters,
+          Crystalline::Boolean.new,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("has_suspicious_characters"),
+              required: true
+            }
+          }
+        )
+
+        field(
+          :is_link_shortener,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("is_link_shortener"), required: true}}
+        )
+
+        field(
+          :is_reported,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("is_reported"), required: true}}
+        )
+
+        field(
+          :brand_impersonation,
+          Crystalline::Nilable.new(Models::Components::QueueItemBrandImpersonation),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("brand_impersonation"), required: true}}
+        )
+
+        field(
+          :domain_age_days,
+          Crystalline::Nilable.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("domain_age_days"), required: true}}
+        )
+
+        field(
+          :has_email_setup,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("has_email_setup"), required: true}}
+        )
+
+        field(
+          :redirect_count,
+          Crystalline::Nilable.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("redirect_count"), required: true}}
+        )
+
+        field(
+          :final_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("final_url"), required: true}}
+        )
+
+        field(
+          :bot_protection,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("bot_protection"), required: true}}
+        )
+
+        sig {
+          params(
+            has_suspicious_characters: T::Boolean,
+            is_link_shortener: T::Boolean,
+            is_reported: T::Boolean,
+            brand_impersonation: T.nilable(Models::Components::QueueItemBrandImpersonation),
+            domain_age_days: T.nilable(::Float),
+            has_email_setup: T.nilable(T::Boolean),
+            redirect_count: T.nilable(::Float),
+            final_url: T.nilable(::String),
+            bot_protection: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(
+          has_suspicious_characters:,
+          is_link_shortener:,
+          is_reported:,
+          brand_impersonation: nil,
+          domain_age_days: nil,
+          has_email_setup: nil,
+          redirect_count: nil,
+          final_url: nil,
+          bot_protection: nil
+        )
+          @has_suspicious_characters = has_suspicious_characters
+          @is_link_shortener = is_link_shortener
+          @is_reported = is_reported
+          @brand_impersonation = brand_impersonation
+          @domain_age_days = domain_age_days
+          @has_email_setup = has_email_setup
+          @redirect_count = redirect_count
+          @final_url = final_url
+          @bot_protection = bot_protection
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @has_suspicious_characters == other.has_suspicious_characters
+          return false unless @is_link_shortener == other.is_link_shortener
+          return false unless @is_reported == other.is_reported
+          return false unless @brand_impersonation == other.brand_impersonation
+          return false unless @domain_age_days == other.domain_age_days
+          return false unless @has_email_setup == other.has_email_setup
+          return false unless @redirect_count == other.redirect_count
+          return false unless @final_url == other.final_url
+          return false unless @bot_protection == other.bot_protection
+          true
+        end
+      end
+    end
+  end
+end