moderation_api 1.2.2 → 2.0.1

data/rbi/moderation_api/models/action_update_response.rbi

@@ -0,0 +1,354 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class ActionUpdateResponse < ModerationAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::Models::ActionUpdateResponse,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the action.
+      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
+
+      # The date the action was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # The IDs of the queues the action is available in.
+      sig { returns(T::Array[String]) }
+      attr_accessor :filter_in_queue_ids
+
+      # Whether the action allows any text to be entered as a value or if it must be one
+      # of the possible values.
+      sig { returns(T::Boolean) }
+      attr_accessor :free_text
+
+      # The name of the action.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Show the action in all queues, selected queues or no queues (to use via API
+      # only).
+      sig do
+        returns(
+          ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol
+        )
+      end
+      attr_accessor :position
+
+      # The possible values of the action. The user will be prompted to select one of
+      # these values when executing the action.
+      sig do
+        returns(
+          T::Array[ModerationAPI::Models::ActionUpdateResponse::PossibleValue]
+        )
+      end
+      attr_accessor :possible_values
+
+      # Whether the action resolves and removes the item, unresolves and re-add it to
+      # the queue, or does not change the resolve status.
+      sig do
+        returns(
+          ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol
+        )
+      end
+      attr_accessor :queue_behaviour
+
+      # Whether the action requires a value to be executed.
+      sig { returns(T::Boolean) }
+      attr_accessor :value_required
+
+      # The description of the action.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # User defined key of the action.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :key
+
+      # The type of the action.
+      sig do
+        returns(
+          T.nilable(
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          built_in: T.nilable(T::Boolean),
+          created_at: String,
+          filter_in_queue_ids: T::Array[String],
+          free_text: T::Boolean,
+          name: String,
+          position:
+            ModerationAPI::Models::ActionUpdateResponse::Position::OrSymbol,
+          possible_values:
+            T::Array[
+              ModerationAPI::Models::ActionUpdateResponse::PossibleValue::OrHash
+            ],
+          queue_behaviour:
+            ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::OrSymbol,
+          value_required: T::Boolean,
+          description: T.nilable(String),
+          key: T.nilable(String),
+          type:
+            T.nilable(
+              ModerationAPI::Models::ActionUpdateResponse::Type::OrSymbol
+            )
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the action.
+        id:,
+        # Whether the action is a built-in action or a custom one.
+        built_in:,
+        # The date the action was created.
+        created_at:,
+        # The IDs of the queues the action is available in.
+        filter_in_queue_ids:,
+        # Whether the action allows any text to be entered as a value or if it must be one
+        # of the possible values.
+        free_text:,
+        # The name of the action.
+        name:,
+        # Show the action in all queues, selected queues or no queues (to use via API
+        # only).
+        position:,
+        # The possible values of the action. The user will be prompted to select one of
+        # these values when executing the action.
+        possible_values:,
+        # Whether the action resolves and removes the item, unresolves and re-add it to
+        # the queue, or does not change the resolve status.
+        queue_behaviour:,
+        # Whether the action requires a value to be executed.
+        value_required:,
+        # The description of the action.
+        description: nil,
+        # User defined key of the action.
+        key: nil,
+        # The type of the action.
+        type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            built_in: T.nilable(T::Boolean),
+            created_at: String,
+            filter_in_queue_ids: T::Array[String],
+            free_text: T::Boolean,
+            name: String,
+            position:
+              ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol,
+            possible_values:
+              T::Array[
+                ModerationAPI::Models::ActionUpdateResponse::PossibleValue
+              ],
+            queue_behaviour:
+              ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol,
+            value_required: T::Boolean,
+            description: T.nilable(String),
+            key: T.nilable(String),
+            type:
+              T.nilable(
+                ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+              )
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Show the action in all queues, selected queues or no queues (to use via API
+      # only).
+      module Position
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModerationAPI::Models::ActionUpdateResponse::Position)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALL_QUEUES =
+          T.let(
+            :ALL_QUEUES,
+            ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol
+          )
+        SOME_QUEUES =
+          T.let(
+            :SOME_QUEUES,
+            ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol
+          )
+        HIDDEN =
+          T.let(
+            :HIDDEN,
+            ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::ActionUpdateResponse::Position::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class PossibleValue < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Models::ActionUpdateResponse::PossibleValue,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # The value of the action.
+        sig { returns(String) }
+        attr_accessor :value
+
+        sig { params(value: String).returns(T.attached_class) }
+        def self.new(
+          # The value of the action.
+          value:
+        )
+        end
+
+        sig { override.returns({ value: String }) }
+        def to_hash
+        end
+      end
+
+      # Whether the action resolves and removes the item, unresolves and re-add it to
+      # the queue, or does not change the resolve status.
+      module QueueBehaviour
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REMOVE =
+          T.let(
+            :REMOVE,
+            ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol
+          )
+        ADD =
+          T.let(
+            :ADD,
+            ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol
+          )
+        NO_CHANGE =
+          T.let(
+            :NO_CHANGE,
+            ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of the action.
+      module Type
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModerationAPI::Models::ActionUpdateResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AUTHOR_BLOCK =
+          T.let(
+            :AUTHOR_BLOCK,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_BLOCK_TEMP =
+          T.let(
+            :AUTHOR_BLOCK_TEMP,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_UNBLOCK =
+          T.let(
+            :AUTHOR_UNBLOCK,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_DELETE =
+          T.let(
+            :AUTHOR_DELETE,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_REPORT =
+          T.let(
+            :AUTHOR_REPORT,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_WARN =
+          T.let(
+            :AUTHOR_WARN,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        AUTHOR_CUSTOM =
+          T.let(
+            :AUTHOR_CUSTOM,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        ITEM_REJECT =
+          T.let(
+            :ITEM_REJECT,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        ITEM_ALLOW =
+          T.let(
+            :ITEM_ALLOW,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+        ITEM_CUSTOM =
+          T.let(
+            :ITEM_CUSTOM,
+            ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::ActionUpdateResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    module Actions
+      class ExecuteExecuteByIDParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Actions::ExecuteExecuteByIDParams,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # IDs of the authors to apply the action to
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :author_ids
+
+        sig { params(author_ids: T::Array[String]).void }
+        attr_writer :author_ids
+
+        # The IDs of the content items to perform the action on.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :content_ids
+
+        sig { params(content_ids: T::Array[String]).void }
+        attr_writer :content_ids
+
+        # The ID of the queue the action was performed from if any.
+        sig { returns(T.nilable(String)) }
+        attr_reader :queue_id
+
+        sig { params(queue_id: String).void }
+        attr_writer :queue_id
+
+        # The value of the action. Useful to set a reason for the action etc.
+        sig { returns(T.nilable(String)) }
+        attr_reader :value
+
+        sig { params(value: String).void }
+        attr_writer :value
+
+        sig do
+          params(
+            author_ids: T::Array[String],
+            content_ids: T::Array[String],
+            queue_id: String,
+            value: String,
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # IDs of the authors to apply the action to
+          author_ids: nil,
+          # The IDs of the content items to perform the action on.
+          content_ids: nil,
+          # The ID of the queue the action was performed from if any.
+          queue_id: nil,
+          # The value of the action. Useful to set a reason for the action etc.
+          value: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              author_ids: T::Array[String],
+              content_ids: T::Array[String],
+              queue_id: String,
+              value: String,
+              request_options: ModerationAPI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/actions/execute_execute_by_id_response.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    module Actions
+      class ExecuteExecuteByIDResponse < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Models::Actions::ExecuteExecuteByIDResponse,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the action.
+        sig { returns(String) }
+        attr_accessor :action_id
+
+        # The IDs of the content items.
+        sig { returns(T::Array[String]) }
+        attr_accessor :ids
+
+        # Action executed successfully.
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig do
+          params(
+            action_id: String,
+            ids: T::Array[String],
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the action.
+          action_id:,
+          # The IDs of the content items.
+          ids:,
+          # Action executed successfully.
+          success:
+        )
+        end
+
+        sig do
+          override.returns(
+            { action_id: String, ids: T::Array[String], success: T::Boolean }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/actions/execute_execute_params.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    module Actions
+      class ExecuteExecuteParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Actions::ExecuteExecuteParams,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # ID or key of the action to execute
+        sig { returns(String) }
+        attr_accessor :action_key
+
+        # IDs of the authors to apply the action to. Provide this or contentIds.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :author_ids
+
+        sig { params(author_ids: T::Array[String]).void }
+        attr_writer :author_ids
+
+        # IDs of the content items to apply the action to. Provide this or authorIds.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :content_ids
+
+        sig { params(content_ids: T::Array[String]).void }
+        attr_writer :content_ids
+
+        # Optional duration in milliseconds for actions with timeouts
+        sig { returns(T.nilable(Float)) }
+        attr_reader :duration
+
+        sig { params(duration: Float).void }
+        attr_writer :duration
+
+        # Optional queue ID if the action is queue-specific
+        sig { returns(T.nilable(String)) }
+        attr_reader :queue_id
+
+        sig { params(queue_id: String).void }
+        attr_writer :queue_id
+
+        # Optional value to provide with the action
+        sig { returns(T.nilable(String)) }
+        attr_reader :value
+
+        sig { params(value: String).void }
+        attr_writer :value
+
+        sig do
+          params(
+            action_key: String,
+            author_ids: T::Array[String],
+            content_ids: T::Array[String],
+            duration: Float,
+            queue_id: String,
+            value: String,
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # ID or key of the action to execute
+          action_key:,
+          # IDs of the authors to apply the action to. Provide this or contentIds.
+          author_ids: nil,
+          # IDs of the content items to apply the action to. Provide this or authorIds.
+          content_ids: nil,
+          # Optional duration in milliseconds for actions with timeouts
+          duration: nil,
+          # Optional queue ID if the action is queue-specific
+          queue_id: nil,
+          # Optional value to provide with the action
+          value: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action_key: String,
+              author_ids: T::Array[String],
+              content_ids: T::Array[String],
+              duration: Float,
+              queue_id: String,
+              value: String,
+              request_options: ModerationAPI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/actions/execute_execute_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    module Actions
+      class ExecuteExecuteResponse < ModerationAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModerationAPI::Models::Actions::ExecuteExecuteResponse,
+              ModerationAPI::Internal::AnyHash
+            )
+          end
+
+        # Whether the action was executed successfully
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        # Execution result
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # Whether the action was executed successfully
+          success:
+        )
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/auth_create_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class AuthCreateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::AuthCreateParams,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: ModerationAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/auth_create_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class AuthCreateResponse < ModerationAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::Models::AuthCreateResponse,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # Message of the authentication
+      sig { returns(String) }
+      attr_accessor :message
+
+      # Name of the authenticated project
+      sig { returns(String) }
+      attr_accessor :project
+
+      # Status of the authentication
+      sig { returns(String) }
+      attr_accessor :status
+
+      sig do
+        params(message: String, project: String, status: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Message of the authentication
+        message:,
+        # Name of the authenticated project
+        project:,
+        # Status of the authentication
+        status:
+      )
+      end
+
+      sig do
+        override.returns({ message: String, project: String, status: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end