moderation_api 2.33.0 → 2.35.0

data/rbi/moderation_api/models/content_stream_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class ContentStreamParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::ContentStreamParams,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          ModerationAPI::ContentStreamParams::SecWebSocketProtocol::OrSymbol
+        )
+      end
+      attr_accessor :sec_web_socket_protocol
+
+      sig do
+        params(
+          sec_web_socket_protocol:
+            ModerationAPI::ContentStreamParams::SecWebSocketProtocol::OrSymbol,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(sec_web_socket_protocol:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            sec_web_socket_protocol:
+              ModerationAPI::ContentStreamParams::SecWebSocketProtocol::OrSymbol,
+            request_options: ModerationAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module SecWebSocketProtocol
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModerationAPI::ContentStreamParams::SecWebSocketProtocol
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MODERATIONAPI_V1 =
+          T.let(
+            :"moderationapi.v1",
+            ModerationAPI::ContentStreamParams::SecWebSocketProtocol::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::ContentStreamParams::SecWebSocketProtocol::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/content_submit_response.rbi

@@ -28,6 +28,28 @@ module ModerationAPI
       end
       attr_writer :author
 
+      # 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.
+      sig do
+        returns(
+          T.nilable(ModerationAPI::Models::ContentSubmitResponse::Casebook)
+        )
+      end
+      attr_reader :casebook
+
+      sig do
+        params(
+          casebook:
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::OrHash
+            )
+        ).void
+      end
+      attr_writer :casebook
+
       # Potentially modified content.
       sig { returns(ModerationAPI::Models::ContentSubmitResponse::Content) }
       attr_reader :content
@@ -122,6 +144,10 @@ module ModerationAPI
             T.nilable(
               ModerationAPI::Models::ContentSubmitResponse::Author::OrHash
             ),
+          casebook:
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::OrHash
+            ),
           content:
             ModerationAPI::Models::ContentSubmitResponse::Content::OrHash,
           evaluation:
@@ -153,6 +179,12 @@ module ModerationAPI
         # The author of the content if your account has authors enabled. Requires you to
         # send authorId when submitting content.
         author:,
+        # 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.
+        casebook:,
         # Potentially modified content.
         content:,
         # The evaluation of the content after running the channel policies.
@@ -175,6 +207,8 @@ module ModerationAPI
           {
             author:
               T.nilable(ModerationAPI::Models::ContentSubmitResponse::Author),
+            casebook:
+              T.nilable(ModerationAPI::Models::ContentSubmitResponse::Casebook),
             content: ModerationAPI::Models::ContentSubmitResponse::Content,
             evaluation:
               ModerationAPI::Models::ContentSubmitResponse::Evaluation,
@@ -419,6 +453,193 @@ module ModerationAPI
         end
       end
 
+      class Casebook < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # How unanimous the matching cases are, from 0 to 1: the share of them that
+        # decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+        # is returned — below that the casebook reports a disagreement instead of picking
+        # a side — so it tells you how clean the consensus was, and is not a threshold to
+        # re-apply yourself.
+        sig { returns(Float) }
+        attr_accessor :agreement
+
+        # How many of your past cases backed this ruling.
+        sig { returns(Float) }
+        attr_accessor :case_count
+
+        # How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+        # by how much evidence backs it, so a handful of close, recent cases outweighs one
+        # distant one. Older cases count for less, halving in weight roughly every 180
+        # days. This is the number to use in rules when you want a strength condition.
+        sig { returns(Float) }
+        attr_accessor :confidence
+
+        # How close the nearest matching case is, from 0 to 1. 1 means the content is
+        # identical to something you have already decided.
+        sig { returns(Float) }
+        attr_accessor :similarity
+
+        # The topic the closest matching case is filed under, or null when it has not been
+        # grouped into one yet.
+        sig do
+          returns(
+            T.nilable(
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic
+            )
+          )
+        end
+        attr_reader :topic
+
+        sig do
+          params(
+            topic:
+              T.nilable(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic::OrHash
+              )
+          ).void
+        end
+        attr_writer :topic
+
+        # The ruling your past decisions point to for this content.
+        sig do
+          returns(
+            ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+          )
+        end
+        attr_accessor :verdict
+
+        # 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.
+        sig do
+          params(
+            agreement: Float,
+            case_count: Float,
+            confidence: Float,
+            similarity: Float,
+            topic:
+              T.nilable(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic::OrHash
+              ),
+            verdict:
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # How unanimous the matching cases are, from 0 to 1: the share of them that
+          # decided this way, ignoring how many there are. Always at least 0.8 when a ruling
+          # is returned — below that the casebook reports a disagreement instead of picking
+          # a side — so it tells you how clean the consensus was, and is not a threshold to
+          # re-apply yourself.
+          agreement:,
+          # How many of your past cases backed this ruling.
+          case_count:,
+          # How strongly the casebook holds this ruling, from 0 to 1: the agreement scaled
+          # by how much evidence backs it, so a handful of close, recent cases outweighs one
+          # distant one. Older cases count for less, halving in weight roughly every 180
+          # days. This is the number to use in rules when you want a strength condition.
+          confidence:,
+          # How close the nearest matching case is, from 0 to 1. 1 means the content is
+          # identical to something you have already decided.
+          similarity:,
+          # The topic the closest matching case is filed under, or null when it has not been
+          # grouped into one yet.
+          topic:,
+          # The ruling your past decisions point to for this content.
+          verdict:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              agreement: Float,
+              case_count: Float,
+              confidence: Float,
+              similarity: Float,
+              topic:
+                T.nilable(
+                  ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic
+                ),
+              verdict:
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Topic < ModerationAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Topic,
+                ModerationAPI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :label
+
+          # The topic the closest matching case is filed under, or null when it has not been
+          # grouped into one yet.
+          sig { params(id: String, label: String).returns(T.attached_class) }
+          def self.new(id:, label:)
+          end
+
+          sig { override.returns({ id: String, label: String }) }
+          def to_hash
+          end
+        end
+
+        # The ruling your past decisions point to for this content.
+        module Verdict
+          extend ModerationAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALLOW =
+            T.let(
+              :allow,
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            )
+          REJECT =
+            T.let(
+              :reject,
+              ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModerationAPI::Models::ContentSubmitResponse::Casebook::Verdict::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Content < ModerationAPI::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1828,6 +2049,11 @@ module ModerationAPI
               :client_override,
               ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
             )
+          CASEBOOK_MATCH =
+            T.let(
+              :casebook_match,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
         end
 
         class MatchedRule < ModerationAPI::Internal::Type::BaseModel

data/rbi/moderation_api/models/webhook_create_params.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookCreateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::WebhookCreateParams,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # Event types this webhook subscribes to. One webhook URL receives all events you
+      # list here.
+      sig do
+        returns(
+          T::Array[ModerationAPI::WebhookCreateParams::EventType::OrSymbol]
+        )
+      end
+      attr_accessor :event_types
+
+      # The webhook's name, used to identify it in the dashboard
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The webhook's URL. We'll call this URL when an event occurs.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # The webhook's description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig do
+        params(
+          event_types:
+            T::Array[ModerationAPI::WebhookCreateParams::EventType::OrSymbol],
+          name: String,
+          url: String,
+          description: T.nilable(String),
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Event types this webhook subscribes to. One webhook URL receives all events you
+        # list here.
+        event_types:,
+        # The webhook's name, used to identify it in the dashboard
+        name:,
+        # The webhook's URL. We'll call this URL when an event occurs.
+        url:,
+        # The webhook's description
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event_types:
+              T::Array[ModerationAPI::WebhookCreateParams::EventType::OrSymbol],
+            name: String,
+            url: String,
+            description: T.nilable(String),
+            request_options: ModerationAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModerationAPI::WebhookCreateParams::EventType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUE_ITEM_NEW =
+          T.let(
+            :QUEUE_ITEM_NEW,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_COMPLETED =
+          T.let(
+            :QUEUE_ITEM_COMPLETED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ACTION =
+          T.let(
+            :QUEUE_ITEM_ACTION,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_REJECTED =
+          T.let(
+            :QUEUE_ITEM_REJECTED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ALLOWED =
+          T.let(
+            :QUEUE_ITEM_ALLOWED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_BLOCKED =
+          T.let(
+            :AUTHOR_BLOCKED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_UNBLOCKED =
+          T.let(
+            :AUTHOR_UNBLOCKED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_SUSPENDED =
+          T.let(
+            :AUTHOR_SUSPENDED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_UPDATED =
+          T.let(
+            :AUTHOR_UPDATED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_TRUST_LEVEL_CHANGED =
+          T.let(
+            :AUTHOR_TRUST_LEVEL_CHANGED,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_ACTION =
+          T.let(
+            :AUTHOR_ACTION,
+            ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::WebhookCreateParams::EventType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end