moderation_api 1.2.1 → 2.0.0

data/rbi/moderation_api/resources/actions.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Actions
+      sig { returns(ModerationAPI::Resources::Actions::Execute) }
+      attr_reader :execute
+
+      # Create an action.
+      sig do
+        params(
+          name: String,
+          built_in: T.nilable(T::Boolean),
+          description: T.nilable(String),
+          filter_in_queue_ids: T::Array[String],
+          free_text: T::Boolean,
+          key: T.nilable(String),
+          position: ModerationAPI::ActionCreateParams::Position::OrSymbol,
+          possible_values:
+            T::Array[ModerationAPI::ActionCreateParams::PossibleValue::OrHash],
+          queue_behaviour:
+            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(ModerationAPI::Models::ActionCreateResponse)
+      end
+      def create(
+        # The name of the action.
+        name:,
+        # Whether the action is a built-in action or a custom one.
+        built_in: nil,
+        # The description of the action.
+        description: nil,
+        # The IDs of the queues the action is available in.
+        filter_in_queue_ids: nil,
+        # Whether the action allows any text to be entered as a value or if it must be one
+        # of the possible values.
+        free_text: nil,
+        # User defined key of the action.
+        key: nil,
+        # Show the action in all queues, selected queues or no queues (to use via API
+        # only).
+        position: nil,
+        # The possible values of the action. The user will be prompted to select one of
+        # these values when executing the action.
+        possible_values: nil,
+        # 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: nil,
+        # The type of the action.
+        type: nil,
+        # Whether the action requires a value to be executed.
+        value_required: nil,
+        # The action's webhooks.
+        webhooks: nil,
+        request_options: {}
+      )
+      end
+
+      # Get an action by ID.
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::ActionRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the action to get.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update an action.
+      sig do
+        params(
+          id: String,
+          built_in: T.nilable(T::Boolean),
+          description: T.nilable(String),
+          filter_in_queue_ids: T::Array[String],
+          free_text: T::Boolean,
+          key: T.nilable(String),
+          name: String,
+          position: ModerationAPI::ActionUpdateParams::Position::OrSymbol,
+          possible_values:
+            T::Array[ModerationAPI::ActionUpdateParams::PossibleValue::OrHash],
+          queue_behaviour:
+            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(ModerationAPI::Models::ActionUpdateResponse)
+      end
+      def update(
+        # 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.
+        description: nil,
+        # The IDs of the queues the action is available in.
+        filter_in_queue_ids: nil,
+        # Whether the action allows any text to be entered as a value or if it must be one
+        # of the possible values.
+        free_text: nil,
+        # User defined key of the action.
+        key: nil,
+        # The name of the action.
+        name: nil,
+        # Show the action in all queues, selected queues or no queues (to use via API
+        # only).
+        position: nil,
+        # The possible values of the action. The user will be prompted to select one of
+        # these values when executing the action.
+        possible_values: nil,
+        # 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: nil,
+        # The type of the action.
+        type: nil,
+        # Whether the action requires a value to be executed.
+        value_required: nil,
+        # The action's webhooks.
+        webhooks: nil,
+        request_options: {}
+      )
+      end
+
+      # List all available moderation actions for the authenticated organization.
+      sig do
+        params(
+          queue_id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(T::Array[ModerationAPI::Models::ActionListResponseItem])
+      end
+      def list(queue_id: nil, request_options: {})
+      end
+
+      # Delete an action and all of its webhooks.
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::ActionDeleteResponse)
+      end
+      def delete(
+        # The ID of the action to delete.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/auth.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Auth
+      sig do
+        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
+          ModerationAPI::Models::AuthCreateResponse
+        )
+      end
+      def create(request_options: {})
+      end
+
+      sig do
+        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
+          ModerationAPI::Models::AuthRetrieveResponse
+        )
+      end
+      def retrieve(request_options: {})
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/authors.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Authors
+      # Create a new author. Typically not needed as authors are created automatically
+      # when content is moderated.
+      sig do
+        params(
+          external_id: String,
+          email: T.nilable(String),
+          external_link: T.nilable(String),
+          first_seen: Float,
+          last_seen: Float,
+          manual_trust_level: T.nilable(Float),
+          metadata: ModerationAPI::AuthorCreateParams::Metadata::OrHash,
+          name: T.nilable(String),
+          profile_picture: T.nilable(String),
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::AuthorCreateResponse)
+      end
+      def create(
+        # External ID of the user, typically the ID of the author in your database.
+        external_id:,
+        # Author email address
+        email: nil,
+        # URL of the author's external profile
+        external_link: nil,
+        # Timestamp when author first appeared
+        first_seen: nil,
+        # Timestamp of last activity
+        last_seen: nil,
+        manual_trust_level: nil,
+        # Additional metadata provided by your system. We recommend including any relevant
+        # information that may assist in the moderation process.
+        metadata: nil,
+        # Author name or identifier
+        name: nil,
+        # URL of the author's profile picture
+        profile_picture: nil,
+        request_options: {}
+      )
+      end
+
+      # Get detailed information about a specific author including historical data and
+      # analysis
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::AuthorRetrieveResponse)
+      end
+      def retrieve(
+        # Either external ID or the ID assigned by moderation API.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update the details of a specific author
+      sig do
+        params(
+          id: String,
+          email: T.nilable(String),
+          external_link: T.nilable(String),
+          first_seen: Float,
+          last_seen: Float,
+          manual_trust_level: T.nilable(Float),
+          metadata: ModerationAPI::AuthorUpdateParams::Metadata::OrHash,
+          name: T.nilable(String),
+          profile_picture: T.nilable(String),
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::AuthorUpdateResponse)
+      end
+      def update(
+        # Either external ID or the ID assigned by moderation API.
+        id,
+        # Author email address
+        email: nil,
+        # URL of the author's external profile
+        external_link: nil,
+        # Timestamp when author first appeared
+        first_seen: nil,
+        # Timestamp of last activity
+        last_seen: nil,
+        manual_trust_level: nil,
+        # Additional metadata provided by your system. We recommend including any relevant
+        # information that may assist in the moderation process.
+        metadata: nil,
+        # Author name or identifier
+        name: nil,
+        # URL of the author's profile picture
+        profile_picture: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a paginated list of authors with their activity metrics and reputation
+      sig do
+        params(
+          content_types: String,
+          last_active_date: String,
+          member_since_date: String,
+          page_number: Float,
+          page_size: Float,
+          sort_by: ModerationAPI::AuthorListParams::SortBy::OrSymbol,
+          sort_direction:
+            ModerationAPI::AuthorListParams::SortDirection::OrSymbol,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::AuthorListResponse)
+      end
+      def list(
+        content_types: nil,
+        last_active_date: nil,
+        member_since_date: nil,
+        # Page number to fetch
+        page_number: nil,
+        # Number of authors per page
+        page_size: nil,
+        sort_by: nil,
+        # Sort direction
+        sort_direction: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a specific author
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::AuthorDeleteResponse)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/content.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Content
+      sig do
+        params(
+          content:
+            T.any(
+              ModerationAPI::ContentSubmitParams::Content::Text::OrHash,
+              ModerationAPI::ContentSubmitParams::Content::Image::OrHash,
+              ModerationAPI::ContentSubmitParams::Content::Video::OrHash,
+              ModerationAPI::ContentSubmitParams::Content::Audio::OrHash,
+              ModerationAPI::ContentSubmitParams::Content::Object::OrHash
+            ),
+          author_id: String,
+          channel: String,
+          content_id: String,
+          conversation_id: String,
+          do_not_store: T::Boolean,
+          metadata: T::Hash[Symbol, T.anything],
+          meta_type: ModerationAPI::ContentSubmitParams::MetaType::OrSymbol,
+          policies:
+            T::Array[
+              T.any(
+                ModerationAPI::ContentSubmitParams::Policy::Toxicity::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::PersonalInformation::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::ToxicitySevere::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Hate::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Illicit::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::IllicitDrugs::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::IllicitAlcohol::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::IllicitFirearms::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::IllicitTobacco::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::IllicitGambling::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Sexual::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Flirtation::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Profanity::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Violence::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::SelfHarm::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Spam::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::SelfPromotion::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Political::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Religion::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::CodeAbuse::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::PiiMasking::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::URLMasking::OrHash,
+                ModerationAPI::ContentSubmitParams::Policy::Guideline::OrHash
+              )
+            ],
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::ContentSubmitResponse)
+      end
+      def submit(
+        # The content sent for moderation
+        content:,
+        # The author of the content.
+        author_id: nil,
+        # Provide a channel ID or key. Will use the project's default channel if not
+        # provided.
+        channel: nil,
+        # The unique ID of the content in your database.
+        content_id: nil,
+        # For example the ID of a chat room or a post
+        conversation_id: nil,
+        # Do not store the content. The content won't enter the review queue
+        do_not_store: nil,
+        # Any metadata you want to store with the content
+        metadata: nil,
+        # The meta type of content being moderated
+        meta_type: nil,
+        # (Enterprise) override the channel policies for this moderation request only.
+        policies: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/queue/items.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Queue
+      class Items
+        # Get paginated list of items in a moderation queue with filtering options
+        sig do
+          params(
+            id: String,
+            after_date: String,
+            author_id: String,
+            before_date: String,
+            conversation_ids: String,
+            filtered_action_ids: String,
+            include_resolved: String,
+            labels: String,
+            page_number: Float,
+            page_size: Float,
+            sort_direction:
+              ModerationAPI::Queue::ItemListParams::SortDirection::OrSymbol,
+            sort_field:
+              ModerationAPI::Queue::ItemListParams::SortField::OrSymbol,
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(ModerationAPI::Models::Queue::ItemListResponse)
+        end
+        def list(
+          # The queue ID
+          id,
+          after_date: nil,
+          author_id: nil,
+          before_date: nil,
+          conversation_ids: nil,
+          filtered_action_ids: nil,
+          include_resolved: nil,
+          labels: nil,
+          # Page number to fetch
+          page_number: nil,
+          # Number of items per page
+          page_size: nil,
+          # Sort direction
+          sort_direction: nil,
+          sort_field: nil,
+          request_options: {}
+        )
+        end
+
+        # Mark a queue item as resolved with a specific moderation action
+        sig do
+          params(
+            item_id: String,
+            id: String,
+            comment: String,
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(ModerationAPI::Models::Queue::ItemResolveResponse)
+        end
+        def resolve(
+          # Path param: The item ID to resolve
+          item_id,
+          # Path param: The queue ID
+          id:,
+          # Body param: Optional comment
+          comment: nil,
+          request_options: {}
+        )
+        end
+
+        # Mark a previously resolved queue item as unresolved/pending
+        sig do
+          params(
+            item_id: String,
+            id: String,
+            comment: String,
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(ModerationAPI::Models::Queue::ItemUnresolveResponse)
+        end
+        def unresolve(
+          # Path param: The item ID to unresolve
+          item_id,
+          # Path param: The queue ID
+          id:,
+          # Body param: Optional reason for unresolving the item
+          comment: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/queue.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Queue
+      sig { returns(ModerationAPI::Resources::Queue::Items) }
+      attr_reader :items
+
+      # Get a queue
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::QueueRetrieveResponse)
+      end
+      def retrieve(
+        # The queue ID
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get detailed statistics about a moderation queue including review times, action
+      # counts, and trends
+      sig do
+        params(
+          id: String,
+          within_days: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::QueueGetStatsResponse)
+      end
+      def get_stats(
+        # The queue ID
+        id,
+        # Number of days to analyze statistics for
+        within_days: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/wordlist/words.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Wordlist
+      class Words
+        # Add words to an existing wordlist
+        sig do
+          params(
+            id: String,
+            words: T::Array[String],
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(ModerationAPI::Models::Wordlist::WordAddResponse)
+        end
+        def add(
+          # 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: {}
+        )
+        end
+
+        # Remove words from an existing wordlist
+        sig do
+          params(
+            id: String,
+            words: T::Array[String],
+            request_options: ModerationAPI::RequestOptions::OrHash
+          ).returns(ModerationAPI::Models::Wordlist::WordRemoveResponse)
+        end
+        def remove(
+          # ID of the wordlist to remove words from
+          id,
+          # Array of words to remove from the wordlist
+          words:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/resources/wordlist.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class Wordlist
+      sig { returns(ModerationAPI::Resources::Wordlist::Words) }
+      attr_reader :words
+
+      # Get a specific wordlist by ID
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::WordlistRetrieveResponse)
+      end
+      def retrieve(
+        # ID of the wordlist to get
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update a wordlist
+      sig do
+        params(
+          id: String,
+          description: String,
+          key: String,
+          name: String,
+          strict: T::Boolean,
+          words: T::Array[String],
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::WordlistUpdateResponse)
+      end
+      def update(
+        # ID of the wordlist to update
+        id,
+        # New description for the wordlist
+        description: nil,
+        # New key for the wordlist
+        key: nil,
+        # New name for the wordlist
+        name: nil,
+        # Deprecated. Now using threshold in project settings.
+        strict: nil,
+        # New words for the wordlist. Replace the existing words with these new ones.
+        # Duplicate words will be ignored.
+        words: nil,
+        request_options: {}
+      )
+      end
+
+      # List all wordlists for the authenticated organization
+      sig do
+        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
+          T::Array[ModerationAPI::Models::WordlistListResponseItem]
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Get the current embedding progress status for a wordlist
+      sig do
+        params(
+          id: String,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).returns(ModerationAPI::Models::WordlistGetEmbeddingStatusResponse)
+      end
+      def get_embedding_status(
+        # ID of the wordlist to check embedding status for
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moderation_api/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module ModerationAPI
+  VERSION = T.let(T.unsafe(nil), String)
+end