moderation_api 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d542ff9749f9a6c137824b1931515cde3c27460ea505c1ac50d0f68b2c8dad8
-  data.tar.gz: 3935357457505f9afe64119557934f402cd695493cb5b1078639b01d7704ed9d
+  metadata.gz: 192a6f5315a5b55f4f6b762d716b3d9ce040c173a93985c1155a5debfd69b053
+  data.tar.gz: 8bcf509d720e00d1744c76dffb6aba7f4b6ebf750fad5859816df308c0f96c6f
 SHA512:
-  metadata.gz: 99fdd9f0531aae436f3ece40c4f06700b115bbe11500cb348b8f60306b98eab20757d1a3acc685b3d158598cea5a3e85be863a9a0045c3846395258b5d2c3ff9
-  data.tar.gz: 9dbb208ced1e89d2775f156199bbf8b5502971679cc1f0b28a476b7b092cb34d9e254a43bfcc6a472653ff2623098ed409fc345fce36a0f8847e063d2fbe56f2
+  metadata.gz: 8c684c5b8669978604e1333bb800c61f2af4be0e95d79f4bc9578c56bfc2462a224d0f994fbc3343d99a7996acf130de7a5abd2e53fc3a01456a7a75dd6493d6
+  data.tar.gz: 336064028d535e29f792abf679b80454b5eab96eda45418f6e9f7fc07fa65c61513ea14e6fba4cc01396dad62855e59aa68051fea48183576064b39d70db09a1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.14.0 (2026-04-29)
+
+Full Changelog: [v2.13.0...v2.14.0](https://github.com/moderation-api/sdk-ruby/compare/v2.13.0...v2.14.0)
+
+### Features
+
+* **api:** api update ([ac53fee](https://github.com/moderation-api/sdk-ruby/commit/ac53feeb7fe66fde8f0eac2462e36f5c8aa5da6a))
+
 ## 2.13.0 (2026-04-28)
 
 Full Changelog: [v2.12.0...v2.13.0](https://github.com/moderation-api/sdk-ruby/compare/v2.12.0...v2.13.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "moderation_api", "~> 2.13.0"
+gem "moderation_api", "~> 2.14.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/moderation_api/models/content_submit_response.rb

@@ -849,7 +849,14 @@ module ModerationAPI
         required :reason_codes,
                  -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode] }
 
-        # @!method initialize(action:, reason_codes:)
+        # @!attribute matched_rules
+        #   Rules that matched during evaluation, if rules engine is active.
+        #
+        #   @return [Array<ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule>, nil]
+        optional :matched_rules,
+                 -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule] }
+
+        # @!method initialize(action:, reason_codes:, matched_rules: nil)
         #   Some parameter documentations has been truncated, see
         #   {ModerationAPI::Models::ContentSubmitResponse::Recommendation} for more details.
         #
@@ -858,6 +865,8 @@ module ModerationAPI
         #   @param action [Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::Action] The action to take based on the recommendation
         #
         #   @param reason_codes [Array<Symbol, ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode>] The reason code for the recommendation. Can be used to display a reason to the u
+        #
+        #   @param matched_rules [Array<ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule>] Rules that matched during evaluation, if rules engine is active.
 
         # The action to take based on the recommendation
         #
@@ -882,10 +891,29 @@ module ModerationAPI
           DRY_RUN = :dry_run
           TRUSTED_ALLOW = :trusted_allow
           UNTRUSTED_SEVERITY = :untrusted_severity
+          RULE_MATCH = :rule_match
+          RULE_DEFAULT = :rule_default
+          RULE_FALLBACK = :rule_fallback
 
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        class MatchedRule < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute key
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(key:, name:)
+          #   @param key [String]
+          #   @param name [String]
+        end
       end
 
       class Error < ModerationAPI::Internal::Type::BaseModel

data/lib/moderation_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModerationAPI
-  VERSION = "2.13.0"
+  VERSION = "2.14.0"
 end

data/rbi/moderation_api/models/content_submit_response.rbi

@@ -1599,6 +1599,28 @@ module ModerationAPI
         end
         attr_accessor :reason_codes
 
+        # Rules that matched during evaluation, if rules engine is active.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule
+              ]
+            )
+          )
+        end
+        attr_reader :matched_rules
+
+        sig do
+          params(
+            matched_rules:
+              T::Array[
+                ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule::OrHash
+              ]
+          ).void
+        end
+        attr_writer :matched_rules
+
         # The recommendation for the content based on the evaluation.
         sig do
           params(
@@ -1607,6 +1629,10 @@ module ModerationAPI
             reason_codes:
               T::Array[
                 ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::OrSymbol
+              ],
+            matched_rules:
+              T::Array[
+                ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule::OrHash
               ]
           ).returns(T.attached_class)
         end
@@ -1615,7 +1641,9 @@ module ModerationAPI
           action:,
           # The reason code for the recommendation. Can be used to display a reason to the
           # user.
-          reason_codes:
+          reason_codes:,
+          # Rules that matched during evaluation, if rules engine is active.
+          matched_rules: nil
         )
         end
 
@@ -1627,6 +1655,10 @@ module ModerationAPI
               reason_codes:
                 T::Array[
                   ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+                ],
+              matched_rules:
+                T::Array[
+                  ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule
                 ]
             }
           )
@@ -1716,6 +1748,21 @@ module ModerationAPI
               :untrusted_severity,
               ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
             )
+          RULE_MATCH =
+            T.let(
+              :rule_match,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
+          RULE_DEFAULT =
+            T.let(
+              :rule_default,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
+          RULE_FALLBACK =
+            T.let(
+              :rule_fallback,
+              ModerationAPI::Models::ContentSubmitResponse::Recommendation::ReasonCode::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -1727,6 +1774,30 @@ module ModerationAPI
           def self.values
           end
         end
+
+        class MatchedRule < ModerationAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule,
+                ModerationAPI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :key
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { params(key: String, name: String).returns(T.attached_class) }
+          def self.new(key:, name:)
+          end
+
+          sig { override.returns({ key: String, name: String }) }
+          def to_hash
+          end
+        end
       end
 
       class Error < ModerationAPI::Internal::Type::BaseModel

data/sig/moderation_api/models/content_submit_response.rbs

@@ -680,7 +680,8 @@ module ModerationAPI
       type recommendation =
         {
           action: ModerationAPI::Models::ContentSubmitResponse::Recommendation::action,
-          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code]
+          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code],
+          matched_rules: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]
         }
 
       class Recommendation < ModerationAPI::Internal::Type::BaseModel
@@ -688,14 +689,22 @@ module ModerationAPI
 
         attr_accessor reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code]
 
+        attr_reader matched_rules: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]?
+
+        def matched_rules=: (
+          ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]
+        ) -> ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]
+
         def initialize: (
           action: ModerationAPI::Models::ContentSubmitResponse::Recommendation::action,
-          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code]
+          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code],
+          ?matched_rules: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]
         ) -> void
 
         def to_hash: -> {
           action: ModerationAPI::Models::ContentSubmitResponse::Recommendation::action,
-          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code]
+          reason_codes: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code],
+          matched_rules: ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::MatchedRule]
         }
 
         type action = :review | :allow | :reject
@@ -717,6 +726,9 @@ module ModerationAPI
           | :dry_run
           | :trusted_allow
           | :untrusted_severity
+          | :rule_match
+          | :rule_default
+          | :rule_fallback
 
         module ReasonCode
           extend ModerationAPI::Internal::Type::Enum
@@ -727,9 +739,24 @@ module ModerationAPI
           DRY_RUN: :dry_run
           TRUSTED_ALLOW: :trusted_allow
           UNTRUSTED_SEVERITY: :untrusted_severity
+          RULE_MATCH: :rule_match
+          RULE_DEFAULT: :rule_default
+          RULE_FALLBACK: :rule_fallback
 
           def self?.values: -> ::Array[ModerationAPI::Models::ContentSubmitResponse::Recommendation::reason_code]
         end
+
+        type matched_rule = { key: String, name: String }
+
+        class MatchedRule < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor key: String
+
+          attr_accessor name: String
+
+          def initialize: (key: String, name: String) -> void
+
+          def to_hash: -> { key: String, name: String }
+        end
       end
 
       type error = { id: String, message: String }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moderation_api
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Moderation API
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-28 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi