moderation_api 1.2.2 → 2.0.1

data/lib/moderation_api/models/queue_get_stats_response.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Queue#get_stats
+    class QueueGetStatsResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute action_stats
+      #
+      #   @return [Array<ModerationAPI::Models::QueueGetStatsResponse::ActionStat>]
+      required :action_stats,
+               -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueGetStatsResponse::ActionStat] },
+               api_name: :actionStats
+
+      # @!attribute review_stats
+      #
+      #   @return [ModerationAPI::Models::QueueGetStatsResponse::ReviewStats]
+      required :review_stats,
+               -> { ModerationAPI::Models::QueueGetStatsResponse::ReviewStats },
+               api_name: :reviewStats
+
+      # @!attribute top_reviewers
+      #   List of top reviewers and their statistics
+      #
+      #   @return [Array<ModerationAPI::Models::QueueGetStatsResponse::TopReviewer>]
+      required :top_reviewers,
+               -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer] },
+               api_name: :topReviewers
+
+      # @!attribute trends
+      #
+      #   @return [ModerationAPI::Models::QueueGetStatsResponse::Trends]
+      required :trends, -> { ModerationAPI::Models::QueueGetStatsResponse::Trends }
+
+      # @!method initialize(action_stats:, review_stats:, top_reviewers:, trends:)
+      #   @param action_stats [Array<ModerationAPI::Models::QueueGetStatsResponse::ActionStat>]
+      #
+      #   @param review_stats [ModerationAPI::Models::QueueGetStatsResponse::ReviewStats]
+      #
+      #   @param top_reviewers [Array<ModerationAPI::Models::QueueGetStatsResponse::TopReviewer>] List of top reviewers and their statistics
+      #
+      #   @param trends [ModerationAPI::Models::QueueGetStatsResponse::Trends]
+
+      class ActionStat < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute action_id
+        #   ID of the moderation action
+        #
+        #   @return [String]
+        required :action_id, String, api_name: :actionId
+
+        # @!attribute action_name
+        #   Name of the moderation action
+        #
+        #   @return [String]
+        required :action_name, String, api_name: :actionName
+
+        # @!attribute count
+        #   Number of times this action was taken
+        #
+        #   @return [Float]
+        required :count, Float
+
+        # @!attribute percentage_of_total
+        #   Percentage this action represents of all actions
+        #
+        #   @return [Float]
+        required :percentage_of_total, Float, api_name: :percentageOfTotal
+
+        # @!method initialize(action_id:, action_name:, count:, percentage_of_total:)
+        #   @param action_id [String] ID of the moderation action
+        #
+        #   @param action_name [String] Name of the moderation action
+        #
+        #   @param count [Float] Number of times this action was taken
+        #
+        #   @param percentage_of_total [Float] Percentage this action represents of all actions
+      end
+
+      # @see ModerationAPI::Models::QueueGetStatsResponse#review_stats
+      class ReviewStats < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute average_time_to_review
+        #   Average time in milliseconds to review an item
+        #
+        #   @return [Float]
+        required :average_time_to_review, Float, api_name: :averageTimeToReview
+
+        # @!attribute total_pending
+        #   Total number of items pending review
+        #
+        #   @return [Float]
+        required :total_pending, Float, api_name: :totalPending
+
+        # @!attribute total_reviewed
+        #   Total number of items reviewed
+        #
+        #   @return [Float]
+        required :total_reviewed, Float, api_name: :totalReviewed
+
+        # @!method initialize(average_time_to_review:, total_pending:, total_reviewed:)
+        #   @param average_time_to_review [Float] Average time in milliseconds to review an item
+        #
+        #   @param total_pending [Float] Total number of items pending review
+        #
+        #   @param total_reviewed [Float] Total number of items reviewed
+      end
+
+      class TopReviewer < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute average_time_per_review
+        #   Average review time in milliseconds
+        #
+        #   @return [Float]
+        required :average_time_per_review, Float, api_name: :averageTimePerReview
+
+        # @!attribute name
+        #   Name of the reviewer
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute review_count
+        #   Number of items reviewed
+        #
+        #   @return [Float]
+        required :review_count, Float, api_name: :reviewCount
+
+        # @!attribute top_actions
+        #   Most common actions taken by this reviewer
+        #
+        #   @return [Array<ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction>]
+        required :top_actions,
+                 -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction] },
+                 api_name: :topActions
+
+        # @!attribute user_id
+        #   ID of the reviewer
+        #
+        #   @return [String]
+        required :user_id, String, api_name: :userId
+
+        # @!attribute accuracy_score
+        #   Optional accuracy score based on review quality metrics
+        #
+        #   @return [Float, nil]
+        optional :accuracy_score, Float, api_name: :accuracyScore
+
+        # @!method initialize(average_time_per_review:, name:, review_count:, top_actions:, user_id:, accuracy_score: nil)
+        #   @param average_time_per_review [Float] Average review time in milliseconds
+        #
+        #   @param name [String] Name of the reviewer
+        #
+        #   @param review_count [Float] Number of items reviewed
+        #
+        #   @param top_actions [Array<ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction>] Most common actions taken by this reviewer
+        #
+        #   @param user_id [String] ID of the reviewer
+        #
+        #   @param accuracy_score [Float] Optional accuracy score based on review quality metrics
+
+        class TopAction < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute action_id
+          #   Most used action by this reviewer
+          #
+          #   @return [String]
+          required :action_id, String, api_name: :actionId
+
+          # @!attribute action_name
+          #   Name of the most used action
+          #
+          #   @return [String]
+          required :action_name, String, api_name: :actionName
+
+          # @!attribute count
+          #   Number of times this action was used
+          #
+          #   @return [Float]
+          required :count, Float
+
+          # @!method initialize(action_id:, action_name:, count:)
+          #   @param action_id [String] Most used action by this reviewer
+          #
+          #   @param action_name [String] Name of the most used action
+          #
+          #   @param count [Float] Number of times this action was used
+        end
+      end
+
+      # @see ModerationAPI::Models::QueueGetStatsResponse#trends
+      class Trends < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute daily_review_counts
+        #
+        #   @return [Array<ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount>]
+        required :daily_review_counts,
+                 -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount] },
+                 api_name: :dailyReviewCounts
+
+        # @!attribute flagged_content_trends
+        #
+        #   @return [Array<ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend>]
+        required :flagged_content_trends,
+                 -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend] },
+                 api_name: :flaggedContentTrends
+
+        # @!method initialize(daily_review_counts:, flagged_content_trends:)
+        #   @param daily_review_counts [Array<ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount>]
+        #   @param flagged_content_trends [Array<ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend>]
+
+        class DailyReviewCount < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute count
+          #   Number of reviews on this date
+          #
+          #   @return [Float]
+          required :count, Float
+
+          # @!attribute date
+          #   Date in YYYY-MM-DD format
+          #
+          #   @return [String]
+          required :date, String
+
+          # @!method initialize(count:, date:)
+          #   @param count [Float] Number of reviews on this date
+          #
+          #   @param date [String] Date in YYYY-MM-DD format
+        end
+
+        class FlaggedContentTrend < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute label
+          #   Content flag/label
+          #
+          #   @return [String]
+          required :label, String
+
+          # @!attribute trend
+          #   Trend indicator (-1 to 1) showing if this type of flagged content is increasing
+          #   or decreasing
+          #
+          #   @return [Float]
+          required :trend, Float
+
+          # @!method initialize(label:, trend:)
+          #   Some parameter documentations has been truncated, see
+          #   {ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend} for
+          #   more details.
+          #
+          #   @param label [String] Content flag/label
+          #
+          #   @param trend [Float] Trend indicator (-1 to 1) showing if this type of flagged content is increasing
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Queue#retrieve
+    class QueueRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/queue_retrieve_response.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Queue#retrieve
+    class QueueRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute queue
+      #
+      #   @return [ModerationAPI::Models::QueueRetrieveResponse::Queue]
+      required :queue, -> { ModerationAPI::Models::QueueRetrieveResponse::Queue }
+
+      # @!method initialize(queue:)
+      #   @param queue [ModerationAPI::Models::QueueRetrieveResponse::Queue]
+
+      # @see ModerationAPI::Models::QueueRetrieveResponse#queue
+      class Queue < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute description
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute filter
+        #
+        #   @return [ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter]
+        required :filter, -> { ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter }
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute resolved_items_count
+        #
+        #   @return [Float]
+        required :resolved_items_count, Float, api_name: :resolvedItemsCount
+
+        # @!attribute total_items_count
+        #
+        #   @return [Float]
+        required :total_items_count, Float, api_name: :totalItemsCount
+
+        # @!attribute unresolved_items_count
+        #
+        #   @return [Float]
+        required :unresolved_items_count, Float, api_name: :unresolvedItemsCount
+
+        # @!method initialize(id:, description:, filter:, name:, resolved_items_count:, total_items_count:, unresolved_items_count:)
+        #   @param id [String]
+        #   @param description [String]
+        #   @param filter [ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter]
+        #   @param name [String]
+        #   @param resolved_items_count [Float]
+        #   @param total_items_count [Float]
+        #   @param unresolved_items_count [Float]
+
+        # @see ModerationAPI::Models::QueueRetrieveResponse::Queue#filter
+        class Filter < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute after_date
+          #
+          #   @return [String, nil]
+          optional :after_date, String, api_name: :afterDate
+
+          # @!attribute author_id
+          #
+          #   @return [String, nil]
+          optional :author_id, String, api_name: :authorID
+
+          # @!attribute before_date
+          #
+          #   @return [String, nil]
+          optional :before_date, String, api_name: :beforeDate
+
+          # @!attribute conversation_ids
+          #
+          #   @return [Array<String, nil>, nil]
+          optional :conversation_ids,
+                   ModerationAPI::Internal::Type::ArrayOf[String, nil?: true],
+                   api_name: :conversationIds
+
+          # @!attribute filtered_action_ids
+          #
+          #   @return [Array<String>, nil]
+          optional :filtered_action_ids,
+                   ModerationAPI::Internal::Type::ArrayOf[String],
+                   api_name: :filteredActionIds
+
+          # @!attribute filtered_channel_ids
+          #
+          #   @return [Array<String>, nil]
+          optional :filtered_channel_ids,
+                   ModerationAPI::Internal::Type::ArrayOf[String],
+                   api_name: :filteredChannelIds
+
+          # @!attribute filter_labels
+          #
+          #   @return [Array<ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel>, nil]
+          optional :filter_labels,
+                   -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel] },
+                   api_name: :filterLabels
+
+          # @!attribute labels
+          #
+          #   @return [Array<String>, nil]
+          optional :labels, ModerationAPI::Internal::Type::ArrayOf[String]
+
+          # @!attribute recommendation_actions
+          #
+          #   @return [Array<Symbol, ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::RecommendationAction>, nil]
+          optional :recommendation_actions,
+                   -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::RecommendationAction] },
+                   api_name: :recommendationActions
+
+          # @!attribute show_checked
+          #
+          #   @return [Boolean, nil]
+          optional :show_checked, ModerationAPI::Internal::Type::Boolean, api_name: :showChecked
+
+          # @!method initialize(after_date: nil, author_id: nil, before_date: nil, conversation_ids: nil, filtered_action_ids: nil, filtered_channel_ids: nil, filter_labels: nil, labels: nil, recommendation_actions: nil, show_checked: nil)
+          #   @param after_date [String]
+          #   @param author_id [String]
+          #   @param before_date [String]
+          #   @param conversation_ids [Array<String, nil>]
+          #   @param filtered_action_ids [Array<String>]
+          #   @param filtered_channel_ids [Array<String>]
+          #   @param filter_labels [Array<ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel>]
+          #   @param labels [Array<String>]
+          #   @param recommendation_actions [Array<Symbol, ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::RecommendationAction>]
+          #   @param show_checked [Boolean]
+
+          class FilterLabel < ModerationAPI::Internal::Type::BaseModel
+            # @!attribute label
+            #
+            #   @return [String]
+            required :label, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::Type]
+            required :type,
+                     enum: -> { ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::Type }
+
+            # @!attribute max_threshold
+            #
+            #   @return [Float, nil]
+            optional :max_threshold, Float, api_name: :maxThreshold, nil?: true
+
+            # @!attribute min_threshold
+            #
+            #   @return [Float, nil]
+            optional :min_threshold, Float, api_name: :minThreshold, nil?: true
+
+            # @!method initialize(label:, type:, max_threshold: nil, min_threshold: nil)
+            #   @param label [String]
+            #   @param type [Symbol, ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::Type]
+            #   @param max_threshold [Float, nil]
+            #   @param min_threshold [Float, nil]
+
+            # @see ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel#type
+            module Type
+              extend ModerationAPI::Internal::Type::Enum
+
+              FLAGGED = :FLAGGED
+              NOT_FLAGGED = :NOT_FLAGGED
+              THRESHOLDS = :THRESHOLDS
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          module RecommendationAction
+            extend ModerationAPI::Internal::Type::Enum
+
+            REVIEW = :review
+            ALLOW = :allow
+            REJECT = :reject
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/wordlist/word_add_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Wordlist
+      # @see ModerationAPI::Resources::Wordlist::Words#add
+      class WordAddParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        # @!attribute words
+        #   Array of words to add to the wordlist. Duplicate words will be ignored.
+        #
+        #   @return [Array<String>]
+        required :words, ModerationAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(words:, request_options: {})
+        #   @param words [Array<String>] Array of words to add to the wordlist. Duplicate words will be ignored.
+        #
+        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/wordlist/word_add_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Wordlist
+      # @see ModerationAPI::Resources::Wordlist::Words#add
+      class WordAddResponse < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute added_count
+        #   Number of words added
+        #
+        #   @return [Float]
+        required :added_count, Float, api_name: :addedCount
+
+        # @!attribute added_words
+        #   List of words that were added
+        #
+        #   @return [Array<String>]
+        required :added_words, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :addedWords
+
+        # @!attribute total_count
+        #   Total number of words in wordlist
+        #
+        #   @return [Float]
+        required :total_count, Float, api_name: :totalCount
+
+        # @!method initialize(added_count:, added_words:, total_count:)
+        #   @param added_count [Float] Number of words added
+        #
+        #   @param added_words [Array<String>] List of words that were added
+        #
+        #   @param total_count [Float] Total number of words in wordlist
+      end
+    end
+  end
+end

data/lib/moderation_api/models/wordlist/word_remove_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Wordlist
+      # @see ModerationAPI::Resources::Wordlist::Words#remove
+      class WordRemoveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        # @!attribute words
+        #   Array of words to remove from the wordlist
+        #
+        #   @return [Array<String>]
+        required :words, ModerationAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(words:, request_options: {})
+        #   @param words [Array<String>] Array of words to remove from the wordlist
+        #
+        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/wordlist/word_remove_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Wordlist
+      # @see ModerationAPI::Resources::Wordlist::Words#remove
+      class WordRemoveResponse < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute removed_count
+        #   Number of words removed
+        #
+        #   @return [Float]
+        required :removed_count, Float, api_name: :removedCount
+
+        # @!attribute removed_words
+        #   List of words removed
+        #
+        #   @return [Array<String>]
+        required :removed_words, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :removedWords
+
+        # @!attribute total_count
+        #   Total number of words in wordlist
+        #
+        #   @return [Float]
+        required :total_count, Float, api_name: :totalCount
+
+        # @!method initialize(removed_count:, removed_words:, total_count:)
+        #   @param removed_count [Float] Number of words removed
+        #
+        #   @param removed_words [Array<String>] List of words removed
+        #
+        #   @param total_count [Float] Total number of words in wordlist
+      end
+    end
+  end
+end

data/lib/moderation_api/models/wordlist_get_embedding_status_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#get_embedding_status
+    class WordlistGetEmbeddingStatusParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/wordlist_get_embedding_status_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#get_embedding_status
+    class WordlistGetEmbeddingStatusResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute progress
+      #   Percentage of words that have been embedded (0-100)
+      #
+      #   @return [Float]
+      required :progress, Float
+
+      # @!attribute remaining_words
+      #   Number of words still waiting to be embedded
+      #
+      #   @return [Float]
+      required :remaining_words, Float, api_name: :remainingWords
+
+      # @!attribute total_words
+      #   Total number of words in the wordlist
+      #
+      #   @return [Float]
+      required :total_words, Float, api_name: :totalWords
+
+      # @!method initialize(progress:, remaining_words:, total_words:)
+      #   Embedding status details
+      #
+      #   @param progress [Float] Percentage of words that have been embedded (0-100)
+      #
+      #   @param remaining_words [Float] Number of words still waiting to be embedded
+      #
+      #   @param total_words [Float] Total number of words in the wordlist
+    end
+  end
+end

data/lib/moderation_api/models/wordlist_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#list
+    class WordlistListParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end