moderation_api 2.9.0 → 2.10.0

data/rbi/moderation_api/internal/util.rbi

@@ -301,6 +301,26 @@ module ModerationAPI
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: ModerationAPI::Internal::AnyHash).returns(
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: ModerationAPI::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/moderation_api/models/action_delete_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # The ID of the action to delete.
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The ID of the action to delete.
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/action_retrieve_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # The ID of the action to get.
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The ID of the action to get.
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/action_update_params.rbi

@@ -14,6 +14,10 @@ module ModerationAPI
           )
         end
 
+      # The ID of the action to update.
+      sig { returns(String) }
+      attr_accessor :id
+
       # Whether the action is a built-in action or a custom one.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :built_in
@@ -126,6 +130,7 @@ module ModerationAPI
 
       sig do
         params(
+          id: String,
           built_in: T.nilable(T::Boolean),
           description: T.nilable(String),
           filter_in_queue_ids: T::Array[String],
@@ -145,6 +150,8 @@ module ModerationAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # The ID of the action to update.
+        id:,
         # Whether the action is a built-in action or a custom one.
         built_in: nil,
         # The description of the action.
@@ -180,6 +187,7 @@ module ModerationAPI
       sig do
         override.returns(
           {
+            id: String,
             built_in: T.nilable(T::Boolean),
             description: T.nilable(String),
             filter_in_queue_ids: T::Array[String],

data/rbi/moderation_api/models/actions/execute_execute_by_id_params.rbi

@@ -15,6 +15,10 @@ module ModerationAPI
             )
           end
 
+        # The ID or key of the action to execute.
+        sig { returns(String) }
+        attr_accessor :action_id
+
         # IDs of the authors to apply the action to
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :author_ids
@@ -45,6 +49,7 @@ module ModerationAPI
 
         sig do
           params(
+            action_id: String,
             author_ids: T::Array[String],
             content_ids: T::Array[String],
             queue_id: String,
@@ -53,6 +58,8 @@ module ModerationAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The ID or key of the action to execute.
+          action_id:,
           # IDs of the authors to apply the action to
           author_ids: nil,
           # The IDs of the content items to perform the action on.
@@ -68,6 +75,7 @@ module ModerationAPI
         sig do
           override.returns(
             {
+              action_id: String,
               author_ids: T::Array[String],
               content_ids: T::Array[String],
               queue_id: String,

data/rbi/moderation_api/models/author_delete_params.rbi

@@ -14,16 +14,22 @@ module ModerationAPI
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(id:, request_options: {})
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/author_retrieve_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # Either external ID or the ID assigned by moderation API.
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # Either external ID or the ID assigned by moderation API.
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/author_update_params.rbi

@@ -14,6 +14,10 @@ module ModerationAPI
           )
         end
 
+      # Either external ID or the ID assigned by moderation API.
+      sig { returns(String) }
+      attr_accessor :id
+
       # Author email address
       sig { returns(T.nilable(String)) }
       attr_accessor :email
@@ -61,6 +65,7 @@ module ModerationAPI
 
       sig do
         params(
+          id: String,
           email: T.nilable(String),
           external_link: T.nilable(String),
           first_seen: Float,
@@ -73,6 +78,8 @@ module ModerationAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # Either external ID or the ID assigned by moderation API.
+        id:,
         # Author email address
         email: nil,
         # URL of the author's external profile
@@ -96,6 +103,7 @@ module ModerationAPI
       sig do
         override.returns(
           {
+            id: String,
             email: T.nilable(String),
             external_link: T.nilable(String),
             first_seen: Float,

data/rbi/moderation_api/models/content_submit_params.rbi

@@ -117,6 +117,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::CodeAbuse,
                 ModerationAPI::ContentSubmitParams::Policy::PiiMasking,
                 ModerationAPI::ContentSubmitParams::Policy::URLMasking,
+                ModerationAPI::ContentSubmitParams::Policy::URLRisk,
                 ModerationAPI::ContentSubmitParams::Policy::Guideline
               )
             ]
@@ -155,6 +156,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::CodeAbuse::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::PiiMasking::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::URLMasking::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::URLRisk::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Guideline::OrHash
               )
             ]
@@ -215,6 +217,7 @@ module ModerationAPI
                 ModerationAPI::ContentSubmitParams::Policy::CodeAbuse::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::PiiMasking::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::URLMasking::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::URLRisk::OrHash,
                 ModerationAPI::ContentSubmitParams::Policy::Guideline::OrHash
               )
             ],
@@ -295,6 +298,7 @@ module ModerationAPI
                   ModerationAPI::ContentSubmitParams::Policy::CodeAbuse,
                   ModerationAPI::ContentSubmitParams::Policy::PiiMasking,
                   ModerationAPI::ContentSubmitParams::Policy::URLMasking,
+                  ModerationAPI::ContentSubmitParams::Policy::URLRisk,
                   ModerationAPI::ContentSubmitParams::Policy::Guideline
                 )
               ],
@@ -802,6 +806,7 @@ module ModerationAPI
               ModerationAPI::ContentSubmitParams::Policy::CodeAbuse,
               ModerationAPI::ContentSubmitParams::Policy::PiiMasking,
               ModerationAPI::ContentSubmitParams::Policy::URLMasking,
+              ModerationAPI::ContentSubmitParams::Policy::URLRisk,
               ModerationAPI::ContentSubmitParams::Policy::Guideline
             )
           end
@@ -1852,6 +1857,42 @@ module ModerationAPI
           end
         end
 
+        class URLRisk < ModerationAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModerationAPI::ContentSubmitParams::Policy::URLRisk,
+                ModerationAPI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :id
+
+          sig { returns(T::Boolean) }
+          attr_accessor :flag
+
+          sig { returns(T.nilable(Float)) }
+          attr_reader :threshold
+
+          sig { params(threshold: Float).void }
+          attr_writer :threshold
+
+          sig do
+            params(flag: T::Boolean, threshold: Float, id: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(flag:, threshold: nil, id: :url_risk)
+          end
+
+          sig do
+            override.returns({ id: Symbol, flag: T::Boolean, threshold: Float })
+          end
+          def to_hash
+          end
+        end
+
         class Guideline < ModerationAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/moderation_api/models/queue/item_list_params.rbi

@@ -15,6 +15,10 @@ module ModerationAPI
             )
           end
 
+        # The queue ID
+        sig { returns(String) }
+        attr_accessor :id
+
         sig { returns(T.nilable(String)) }
         attr_reader :after_date
 
@@ -106,6 +110,7 @@ module ModerationAPI
 
         sig do
           params(
+            id: String,
             after_date: String,
             author_id: String,
             before_date: String,
@@ -123,6 +128,8 @@ module ModerationAPI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The queue ID
+          id:,
           after_date: nil,
           author_id: nil,
           before_date: nil,
@@ -144,6 +151,7 @@ module ModerationAPI
         sig do
           override.returns(
             {
+              id: String,
               after_date: String,
               author_id: String,
               before_date: String,

data/rbi/moderation_api/models/queue/item_resolve_params.rbi

@@ -19,6 +19,10 @@ module ModerationAPI
         sig { returns(String) }
         attr_accessor :id
 
+        # The item ID to resolve
+        sig { returns(String) }
+        attr_accessor :item_id
+
         # Optional comment
         sig { returns(T.nilable(String)) }
         attr_reader :comment
@@ -29,6 +33,7 @@ module ModerationAPI
         sig do
           params(
             id: String,
+            item_id: String,
             comment: String,
             request_options: ModerationAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -36,6 +41,8 @@ module ModerationAPI
         def self.new(
           # The queue ID
           id:,
+          # The item ID to resolve
+          item_id:,
           # Optional comment
           comment: nil,
           request_options: {}
@@ -46,6 +53,7 @@ module ModerationAPI
           override.returns(
             {
               id: String,
+              item_id: String,
               comment: String,
               request_options: ModerationAPI::RequestOptions
             }

data/rbi/moderation_api/models/queue/item_unresolve_params.rbi

@@ -19,6 +19,10 @@ module ModerationAPI
         sig { returns(String) }
         attr_accessor :id
 
+        # The item ID to unresolve
+        sig { returns(String) }
+        attr_accessor :item_id
+
         # Optional reason for unresolving the item
         sig { returns(T.nilable(String)) }
         attr_reader :comment
@@ -29,6 +33,7 @@ module ModerationAPI
         sig do
           params(
             id: String,
+            item_id: String,
             comment: String,
             request_options: ModerationAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -36,6 +41,8 @@ module ModerationAPI
         def self.new(
           # The queue ID
           id:,
+          # The item ID to unresolve
+          item_id:,
           # Optional reason for unresolving the item
           comment: nil,
           request_options: {}
@@ -46,6 +53,7 @@ module ModerationAPI
           override.returns(
             {
               id: String,
+              item_id: String,
               comment: String,
               request_options: ModerationAPI::RequestOptions
             }

data/rbi/moderation_api/models/queue_get_stats_params.rbi

@@ -14,6 +14,10 @@ module ModerationAPI
           )
         end
 
+      # The queue ID
+      sig { returns(String) }
+      attr_accessor :id
+
       # Number of days to analyze statistics for
       sig { returns(T.nilable(String)) }
       attr_reader :within_days
@@ -23,11 +27,14 @@ module ModerationAPI
 
       sig do
         params(
+          id: String,
           within_days: String,
           request_options: ModerationAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # The queue ID
+        id:,
         # Number of days to analyze statistics for
         within_days: nil,
         request_options: {}
@@ -37,6 +44,7 @@ module ModerationAPI
       sig do
         override.returns(
           {
+            id: String,
             within_days: String,
             request_options: ModerationAPI::RequestOptions
           }

data/rbi/moderation_api/models/queue_retrieve_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # The queue ID
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # The queue ID
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/wordlist/word_add_params.rbi

@@ -15,17 +15,24 @@ module ModerationAPI
             )
           end
 
+        # ID of the wordlist to add words to
+        sig { returns(String) }
+        attr_accessor :id
+
         # Array of words to add to the wordlist. Duplicate words will be ignored.
         sig { returns(T::Array[String]) }
         attr_accessor :words
 
         sig do
           params(
+            id: String,
             words: T::Array[String],
             request_options: ModerationAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # ID of the wordlist to add words to
+          id:,
           # Array of words to add to the wordlist. Duplicate words will be ignored.
           words:,
           request_options: {}
@@ -35,6 +42,7 @@ module ModerationAPI
         sig do
           override.returns(
             {
+              id: String,
               words: T::Array[String],
               request_options: ModerationAPI::RequestOptions
             }

data/rbi/moderation_api/models/wordlist/word_remove_params.rbi

@@ -15,17 +15,24 @@ module ModerationAPI
             )
           end
 
+        # ID of the wordlist to remove words from
+        sig { returns(String) }
+        attr_accessor :id
+
         # Array of words to remove from the wordlist
         sig { returns(T::Array[String]) }
         attr_accessor :words
 
         sig do
           params(
+            id: String,
             words: T::Array[String],
             request_options: ModerationAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # ID of the wordlist to remove words from
+          id:,
           # Array of words to remove from the wordlist
           words:,
           request_options: {}
@@ -35,6 +42,7 @@ module ModerationAPI
         sig do
           override.returns(
             {
+              id: String,
               words: T::Array[String],
               request_options: ModerationAPI::RequestOptions
             }

data/rbi/moderation_api/models/wordlist_get_embedding_status_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # ID of the wordlist to check embedding status for
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # ID of the wordlist to check embedding status for
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/wordlist_retrieve_params.rbi

@@ -14,16 +14,27 @@ module ModerationAPI
           )
         end
 
+      # ID of the wordlist to get
+      sig { returns(String) }
+      attr_accessor :id
+
       sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # ID of the wordlist to get
+        id:,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
+        override.returns(
+          { id: String, request_options: ModerationAPI::RequestOptions }
+        )
       end
       def to_hash
       end

data/rbi/moderation_api/models/wordlist_update_params.rbi

@@ -14,6 +14,10 @@ module ModerationAPI
           )
         end
 
+      # ID of the wordlist to update
+      sig { returns(String) }
+      attr_accessor :id
+
       # New description for the wordlist
       sig { returns(T.nilable(String)) }
       attr_reader :description
@@ -52,6 +56,7 @@ module ModerationAPI
 
       sig do
         params(
+          id: String,
           description: String,
           key: String,
           name: String,
@@ -61,6 +66,8 @@ module ModerationAPI
         ).returns(T.attached_class)
       end
       def self.new(
+        # ID of the wordlist to update
+        id:,
         # New description for the wordlist
         description: nil,
         # New key for the wordlist
@@ -79,6 +86,7 @@ module ModerationAPI
       sig do
         override.returns(
           {
+            id: String,
             description: String,
             key: String,
             name: String,