moderation_api 2.15.0 → 2.16.0

data/lib/moderation_api/models.rb

@@ -78,6 +78,8 @@ module ModerationAPI
 
   QueueRetrieveParams = ModerationAPI::Models::QueueRetrieveParams
 
+  WebhookEvent = ModerationAPI::Models::WebhookEvent
+
   Wordlist = ModerationAPI::Models::Wordlist
 
   WordlistGetEmbeddingStatusParams = ModerationAPI::Models::WordlistGetEmbeddingStatusParams

data/lib/moderation_api/resources/actions.rb

@@ -11,7 +11,7 @@ module ModerationAPI
       #
       # Create an action.
       #
-      # @overload create(name:, built_in: nil, description: nil, filter_in_queue_ids: nil, free_text: nil, key: nil, position: nil, possible_values: nil, queue_behaviour: nil, type: nil, value_required: nil, webhooks: nil, request_options: {})
+      # @overload create(name:, built_in: nil, description: nil, filter_in_queue_ids: nil, free_text: nil, key: nil, position: nil, possible_values: nil, queue_behaviour: nil, type: nil, value_required: nil, request_options: {})
       #
       # @param name [String] The name of the action.
       #
@@ -35,8 +35,6 @@ module ModerationAPI
       #
       # @param value_required [Boolean] Whether the action requires a value to be executed.
       #
-      # @param webhooks [Array<ModerationAPI::Models::ActionCreateParams::Webhook>] The action's webhooks.
-      #
       # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModerationAPI::Models::ActionCreateResponse]
@@ -78,7 +76,7 @@ module ModerationAPI
       #
       # Update an action.
       #
-      # @overload update(id, built_in: nil, description: nil, filter_in_queue_ids: nil, free_text: nil, key: nil, name: nil, position: nil, possible_values: nil, queue_behaviour: nil, type: nil, value_required: nil, webhooks: nil, request_options: {})
+      # @overload update(id, built_in: nil, description: nil, filter_in_queue_ids: nil, free_text: nil, key: nil, name: nil, position: nil, possible_values: nil, queue_behaviour: nil, type: nil, value_required: nil, request_options: {})
       #
       # @param id [String] The ID of the action to update.
       #
@@ -104,8 +102,6 @@ module ModerationAPI
       #
       # @param value_required [Boolean] Whether the action requires a value to be executed.
       #
-      # @param webhooks [Array<ModerationAPI::Models::ActionUpdateParams::Webhook>] The action's webhooks.
-      #
       # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModerationAPI::Models::ActionUpdateResponse]

data/lib/moderation_api/version.rb

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

data/lib/moderation_api.rb

@@ -94,6 +94,7 @@ require_relative "moderation_api/models/queue_get_stats_params"
 require_relative "moderation_api/models/queue_get_stats_response"
 require_relative "moderation_api/models/queue_retrieve_params"
 require_relative "moderation_api/models/queue_retrieve_response"
+require_relative "moderation_api/models/webhook_event"
 require_relative "moderation_api/models/wordlist/word_add_params"
 require_relative "moderation_api/models/wordlist/word_add_response"
 require_relative "moderation_api/models/wordlist/word_remove_params"

data/rbi/moderation_api/models/action_create_params.rbi

@@ -108,19 +108,6 @@ module ModerationAPI
       sig { params(value_required: T::Boolean).void }
       attr_writer :value_required
 
-      # The action's webhooks.
-      sig do
-        returns(T.nilable(T::Array[ModerationAPI::ActionCreateParams::Webhook]))
-      end
-      attr_reader :webhooks
-
-      sig do
-        params(
-          webhooks: T::Array[ModerationAPI::ActionCreateParams::Webhook::OrHash]
-        ).void
-      end
-      attr_writer :webhooks
-
       sig do
         params(
           name: String,
@@ -136,8 +123,6 @@ module ModerationAPI
             ModerationAPI::ActionCreateParams::QueueBehaviour::OrSymbol,
           type: T.nilable(ModerationAPI::ActionCreateParams::Type::OrSymbol),
           value_required: T::Boolean,
-          webhooks:
-            T::Array[ModerationAPI::ActionCreateParams::Webhook::OrHash],
           request_options: ModerationAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -168,8 +153,6 @@ module ModerationAPI
         type: nil,
         # Whether the action requires a value to be executed.
         value_required: nil,
-        # The action's webhooks.
-        webhooks: nil,
         request_options: {}
       )
       end
@@ -190,7 +173,6 @@ module ModerationAPI
               ModerationAPI::ActionCreateParams::QueueBehaviour::OrSymbol,
             type: T.nilable(ModerationAPI::ActionCreateParams::Type::OrSymbol),
             value_required: T::Boolean,
-            webhooks: T::Array[ModerationAPI::ActionCreateParams::Webhook],
             request_options: ModerationAPI::RequestOptions
           }
         )
@@ -366,68 +348,6 @@ module ModerationAPI
         def self.values
         end
       end
-
-      class Webhook < ModerationAPI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModerationAPI::ActionCreateParams::Webhook,
-              ModerationAPI::Internal::AnyHash
-            )
-          end
-
-        # 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 the event occurs.
-        sig { returns(String) }
-        attr_accessor :url
-
-        # ID of an existing webhook or undefined if this is a new webhook.
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # The webhook's description
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        sig do
-          params(
-            name: String,
-            url: String,
-            id: String,
-            description: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The webhook's name, used to identify it in the dashboard
-          name:,
-          # The webhook's URL. We'll call this URL when the event occurs.
-          url:,
-          # ID of an existing webhook or undefined if this is a new webhook.
-          id: nil,
-          # The webhook's description
-          description: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              name: String,
-              url: String,
-              id: String,
-              description: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/moderation_api/models/action_list_response.rbi

@@ -67,14 +67,6 @@ module ModerationAPI
       sig { returns(T::Boolean) }
       attr_accessor :value_required
 
-      # The action's webhooks.
-      sig do
-        returns(
-          T::Array[ModerationAPI::Models::ActionListResponseItem::Webhook]
-        )
-      end
-      attr_accessor :webhooks
-
       # The description of the action.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -110,10 +102,6 @@ module ModerationAPI
           queue_behaviour:
             ModerationAPI::Models::ActionListResponseItem::QueueBehaviour::OrSymbol,
           value_required: T::Boolean,
-          webhooks:
-            T::Array[
-              ModerationAPI::Models::ActionListResponseItem::Webhook::OrHash
-            ],
           description: T.nilable(String),
           key: T.nilable(String),
           type:
@@ -147,8 +135,6 @@ module ModerationAPI
         queue_behaviour:,
         # Whether the action requires a value to be executed.
         value_required:,
-        # The action's webhooks.
-        webhooks:,
         # The description of the action.
         description: nil,
         # User defined key of the action.
@@ -176,8 +162,6 @@ module ModerationAPI
             queue_behaviour:
               ModerationAPI::Models::ActionListResponseItem::QueueBehaviour::TaggedSymbol,
             value_required: T::Boolean,
-            webhooks:
-              T::Array[ModerationAPI::Models::ActionListResponseItem::Webhook],
             description: T.nilable(String),
             key: T.nilable(String),
             type:
@@ -297,75 +281,6 @@ module ModerationAPI
         end
       end
 
-      class Webhook < ModerationAPI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModerationAPI::Models::ActionListResponseItem::Webhook,
-              ModerationAPI::Internal::AnyHash
-            )
-          end
-
-        # The ID of the webhook.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # 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 the event occurs.
-        sig { returns(String) }
-        attr_accessor :url
-
-        # The webhook's description
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        # The ID of the moderation action to trigger the webhook on. Only used for
-        # moderation action webhooks.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :moderation_action_id
-
-        sig do
-          params(
-            id: String,
-            name: String,
-            url: String,
-            description: T.nilable(String),
-            moderation_action_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ID of the webhook.
-          id:,
-          # The webhook's name, used to identify it in the dashboard
-          name:,
-          # The webhook's URL. We'll call this URL when the event occurs.
-          url:,
-          # The webhook's description
-          description: nil,
-          # The ID of the moderation action to trigger the webhook on. Only used for
-          # moderation action webhooks.
-          moderation_action_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              name: String,
-              url: String,
-              description: T.nilable(String),
-              moderation_action_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # The type of the action.
       module Type
         extend ModerationAPI::Internal::Type::Enum

data/rbi/moderation_api/models/action_retrieve_response.rbi

@@ -67,14 +67,6 @@ module ModerationAPI
       sig { returns(T::Boolean) }
       attr_accessor :value_required
 
-      # The action's webhooks.
-      sig do
-        returns(
-          T::Array[ModerationAPI::Models::ActionRetrieveResponse::Webhook]
-        )
-      end
-      attr_accessor :webhooks
-
       # The description of the action.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -110,10 +102,6 @@ module ModerationAPI
           queue_behaviour:
             ModerationAPI::Models::ActionRetrieveResponse::QueueBehaviour::OrSymbol,
           value_required: T::Boolean,
-          webhooks:
-            T::Array[
-              ModerationAPI::Models::ActionRetrieveResponse::Webhook::OrHash
-            ],
           description: T.nilable(String),
           key: T.nilable(String),
           type:
@@ -147,8 +135,6 @@ module ModerationAPI
         queue_behaviour:,
         # Whether the action requires a value to be executed.
         value_required:,
-        # The action's webhooks.
-        webhooks:,
         # The description of the action.
         description: nil,
         # User defined key of the action.
@@ -176,8 +162,6 @@ module ModerationAPI
             queue_behaviour:
               ModerationAPI::Models::ActionRetrieveResponse::QueueBehaviour::TaggedSymbol,
             value_required: T::Boolean,
-            webhooks:
-              T::Array[ModerationAPI::Models::ActionRetrieveResponse::Webhook],
             description: T.nilable(String),
             key: T.nilable(String),
             type:
@@ -297,75 +281,6 @@ module ModerationAPI
         end
       end
 
-      class Webhook < ModerationAPI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModerationAPI::Models::ActionRetrieveResponse::Webhook,
-              ModerationAPI::Internal::AnyHash
-            )
-          end
-
-        # The ID of the webhook.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # 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 the event occurs.
-        sig { returns(String) }
-        attr_accessor :url
-
-        # The webhook's description
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        # The ID of the moderation action to trigger the webhook on. Only used for
-        # moderation action webhooks.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :moderation_action_id
-
-        sig do
-          params(
-            id: String,
-            name: String,
-            url: String,
-            description: T.nilable(String),
-            moderation_action_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ID of the webhook.
-          id:,
-          # The webhook's name, used to identify it in the dashboard
-          name:,
-          # The webhook's URL. We'll call this URL when the event occurs.
-          url:,
-          # The webhook's description
-          description: nil,
-          # The ID of the moderation action to trigger the webhook on. Only used for
-          # moderation action webhooks.
-          moderation_action_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              name: String,
-              url: String,
-              description: T.nilable(String),
-              moderation_action_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # The type of the action.
       module Type
         extend ModerationAPI::Internal::Type::Enum

data/rbi/moderation_api/models/action_update_params.rbi

@@ -115,19 +115,6 @@ module ModerationAPI
       sig { params(value_required: T::Boolean).void }
       attr_writer :value_required
 
-      # The action's webhooks.
-      sig do
-        returns(T.nilable(T::Array[ModerationAPI::ActionUpdateParams::Webhook]))
-      end
-      attr_reader :webhooks
-
-      sig do
-        params(
-          webhooks: T::Array[ModerationAPI::ActionUpdateParams::Webhook::OrHash]
-        ).void
-      end
-      attr_writer :webhooks
-
       sig do
         params(
           id: String,
@@ -144,8 +131,6 @@ module ModerationAPI
             ModerationAPI::ActionUpdateParams::QueueBehaviour::OrSymbol,
           type: T.nilable(ModerationAPI::ActionUpdateParams::Type::OrSymbol),
           value_required: T::Boolean,
-          webhooks:
-            T::Array[ModerationAPI::ActionUpdateParams::Webhook::OrHash],
           request_options: ModerationAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -178,8 +163,6 @@ module ModerationAPI
         type: nil,
         # Whether the action requires a value to be executed.
         value_required: nil,
-        # The action's webhooks.
-        webhooks: nil,
         request_options: {}
       )
       end
@@ -201,7 +184,6 @@ module ModerationAPI
               ModerationAPI::ActionUpdateParams::QueueBehaviour::OrSymbol,
             type: T.nilable(ModerationAPI::ActionUpdateParams::Type::OrSymbol),
             value_required: T::Boolean,
-            webhooks: T::Array[ModerationAPI::ActionUpdateParams::Webhook],
             request_options: ModerationAPI::RequestOptions
           }
         )
@@ -377,68 +359,6 @@ module ModerationAPI
         def self.values
         end
       end
-
-      class Webhook < ModerationAPI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModerationAPI::ActionUpdateParams::Webhook,
-              ModerationAPI::Internal::AnyHash
-            )
-          end
-
-        # 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 the event occurs.
-        sig { returns(String) }
-        attr_accessor :url
-
-        # ID of an existing webhook or undefined if this is a new webhook.
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        # The webhook's description
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        sig do
-          params(
-            name: String,
-            url: String,
-            id: String,
-            description: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The webhook's name, used to identify it in the dashboard
-          name:,
-          # The webhook's URL. We'll call this URL when the event occurs.
-          url:,
-          # ID of an existing webhook or undefined if this is a new webhook.
-          id: nil,
-          # The webhook's description
-          description: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              name: String,
-              url: String,
-              id: String,
-              description: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end