moderation_api 1.2.1 → 2.0.0

data/lib/moderation_api/resources/actions.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Actions
+      # @return [ModerationAPI::Resources::Actions::Execute]
+      attr_reader :execute
+
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::ActionCreateParams} for more details.
+      #
+      # 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: {})
+      #
+      # @param name [String] The name of the action.
+      #
+      # @param built_in [Boolean, nil] Whether the action is a built-in action or a custom one.
+      #
+      # @param description [String, nil] The description of the action.
+      #
+      # @param filter_in_queue_ids [Array<String>] The IDs of the queues the action is available in.
+      #
+      # @param free_text [Boolean] Whether the action allows any text to be entered as a value or if it must be one
+      #
+      # @param key [String, nil] User defined key of the action.
+      #
+      # @param position [Symbol, ModerationAPI::Models::ActionCreateParams::Position] Show the action in all queues, selected queues or no queues (to use via API only
+      #
+      # @param possible_values [Array<ModerationAPI::Models::ActionCreateParams::PossibleValue>] The possible values of the action. The user will be prompted to select one of th
+      #
+      # @param queue_behaviour [Symbol, ModerationAPI::Models::ActionCreateParams::QueueBehaviour] Whether the action resolves and removes the item, unresolves and re-add it to th
+      #
+      # @param type [Symbol, ModerationAPI::Models::ActionCreateParams::Type, nil] The type of the action.
+      #
+      # @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]
+      #
+      # @see ModerationAPI::Models::ActionCreateParams
+      def create(params)
+        parsed, options = ModerationAPI::ActionCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "actions",
+          body: parsed,
+          model: ModerationAPI::Models::ActionCreateResponse,
+          options: options
+        )
+      end
+
+      # Get an action by ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the action to get.
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::ActionRetrieveResponse]
+      #
+      # @see ModerationAPI::Models::ActionRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["actions/%1$s", id],
+          model: ModerationAPI::Models::ActionRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::ActionUpdateParams} for more details.
+      #
+      # 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: {})
+      #
+      # @param id [String] The ID of the action to update.
+      #
+      # @param built_in [Boolean, nil] Whether the action is a built-in action or a custom one.
+      #
+      # @param description [String, nil] The description of the action.
+      #
+      # @param filter_in_queue_ids [Array<String>] The IDs of the queues the action is available in.
+      #
+      # @param free_text [Boolean] Whether the action allows any text to be entered as a value or if it must be one
+      #
+      # @param key [String, nil] User defined key of the action.
+      #
+      # @param name [String] The name of the action.
+      #
+      # @param position [Symbol, ModerationAPI::Models::ActionUpdateParams::Position] Show the action in all queues, selected queues or no queues (to use via API only
+      #
+      # @param possible_values [Array<ModerationAPI::Models::ActionUpdateParams::PossibleValue>] The possible values of the action. The user will be prompted to select one of th
+      #
+      # @param queue_behaviour [Symbol, ModerationAPI::Models::ActionUpdateParams::QueueBehaviour] Whether the action resolves and removes the item, unresolves and re-add it to th
+      #
+      # @param type [Symbol, ModerationAPI::Models::ActionUpdateParams::Type, nil] The type of the action.
+      #
+      # @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]
+      #
+      # @see ModerationAPI::Models::ActionUpdateParams
+      def update(id, params = {})
+        parsed, options = ModerationAPI::ActionUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["actions/%1$s", id],
+          body: parsed,
+          model: ModerationAPI::Models::ActionUpdateResponse,
+          options: options
+        )
+      end
+
+      # List all available moderation actions for the authenticated organization.
+      #
+      # @overload list(queue_id: nil, request_options: {})
+      #
+      # @param queue_id [String]
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<ModerationAPI::Models::ActionListResponseItem>]
+      #
+      # @see ModerationAPI::Models::ActionListParams
+      def list(params = {})
+        parsed, options = ModerationAPI::ActionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "actions",
+          query: parsed.transform_keys(queue_id: "queueId"),
+          model: ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ActionListResponseItem],
+          options: options
+        )
+      end
+
+      # Delete an action and all of its webhooks.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the action to delete.
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::ActionDeleteResponse]
+      #
+      # @see ModerationAPI::Models::ActionDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["actions/%1$s", id],
+          model: ModerationAPI::Models::ActionDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+        @execute = ModerationAPI::Resources::Actions::Execute.new(client: client)
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/auth.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Auth
+      # @deprecated
+      #
+      # @overload create(request_options: {})
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthCreateResponse]
+      #
+      # @see ModerationAPI::Models::AuthCreateParams
+      def create(params = {})
+        @client.request(
+          method: :post,
+          path: "auth",
+          model: ModerationAPI::Models::AuthCreateResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @deprecated
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthRetrieveResponse]
+      #
+      # @see ModerationAPI::Models::AuthRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "auth",
+          model: ModerationAPI::Models::AuthRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/authors.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Authors
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::AuthorCreateParams} for more details.
+      #
+      # Create a new author. Typically not needed as authors are created automatically
+      # when content is moderated.
+      #
+      # @overload create(external_id:, email: nil, external_link: nil, first_seen: nil, last_seen: nil, manual_trust_level: nil, metadata: nil, name: nil, profile_picture: nil, request_options: {})
+      #
+      # @param external_id [String] External ID of the user, typically the ID of the author in your database.
+      #
+      # @param email [String, nil] Author email address
+      #
+      # @param external_link [String, nil] URL of the author's external profile
+      #
+      # @param first_seen [Float] Timestamp when author first appeared
+      #
+      # @param last_seen [Float] Timestamp of last activity
+      #
+      # @param manual_trust_level [Float, nil]
+      #
+      # @param metadata [ModerationAPI::Models::AuthorCreateParams::Metadata] Additional metadata provided by your system. We recommend including any relevant
+      #
+      # @param name [String, nil] Author name or identifier
+      #
+      # @param profile_picture [String, nil] URL of the author's profile picture
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthorCreateResponse]
+      #
+      # @see ModerationAPI::Models::AuthorCreateParams
+      def create(params)
+        parsed, options = ModerationAPI::AuthorCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "authors",
+          body: parsed,
+          model: ModerationAPI::Models::AuthorCreateResponse,
+          options: options
+        )
+      end
+
+      # Get detailed information about a specific author including historical data and
+      # analysis
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Either external ID or the ID assigned by moderation API.
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthorRetrieveResponse]
+      #
+      # @see ModerationAPI::Models::AuthorRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["authors/%1$s", id],
+          model: ModerationAPI::Models::AuthorRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::AuthorUpdateParams} for more details.
+      #
+      # Update the details of a specific author
+      #
+      # @overload update(id, email: nil, external_link: nil, first_seen: nil, last_seen: nil, manual_trust_level: nil, metadata: nil, name: nil, profile_picture: nil, request_options: {})
+      #
+      # @param id [String] Either external ID or the ID assigned by moderation API.
+      #
+      # @param email [String, nil] Author email address
+      #
+      # @param external_link [String, nil] URL of the author's external profile
+      #
+      # @param first_seen [Float] Timestamp when author first appeared
+      #
+      # @param last_seen [Float] Timestamp of last activity
+      #
+      # @param manual_trust_level [Float, nil]
+      #
+      # @param metadata [ModerationAPI::Models::AuthorUpdateParams::Metadata] Additional metadata provided by your system. We recommend including any relevant
+      #
+      # @param name [String, nil] Author name or identifier
+      #
+      # @param profile_picture [String, nil] URL of the author's profile picture
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthorUpdateResponse]
+      #
+      # @see ModerationAPI::Models::AuthorUpdateParams
+      def update(id, params = {})
+        parsed, options = ModerationAPI::AuthorUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["authors/%1$s", id],
+          body: parsed,
+          model: ModerationAPI::Models::AuthorUpdateResponse,
+          options: options
+        )
+      end
+
+      # Get a paginated list of authors with their activity metrics and reputation
+      #
+      # @overload list(content_types: nil, last_active_date: nil, member_since_date: nil, page_number: nil, page_size: nil, sort_by: nil, sort_direction: nil, request_options: {})
+      #
+      # @param content_types [String]
+      #
+      # @param last_active_date [String]
+      #
+      # @param member_since_date [String]
+      #
+      # @param page_number [Float] Page number to fetch
+      #
+      # @param page_size [Float] Number of authors per page
+      #
+      # @param sort_by [Symbol, ModerationAPI::Models::AuthorListParams::SortBy]
+      #
+      # @param sort_direction [Symbol, ModerationAPI::Models::AuthorListParams::SortDirection] Sort direction
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthorListResponse]
+      #
+      # @see ModerationAPI::Models::AuthorListParams
+      def list(params = {})
+        parsed, options = ModerationAPI::AuthorListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "authors",
+          query: parsed.transform_keys(
+            content_types: "contentTypes",
+            last_active_date: "lastActiveDate",
+            member_since_date: "memberSinceDate",
+            page_number: "pageNumber",
+            page_size: "pageSize",
+            sort_by: "sortBy",
+            sort_direction: "sortDirection"
+          ),
+          model: ModerationAPI::Models::AuthorListResponse,
+          options: options
+        )
+      end
+
+      # Delete a specific author
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AuthorDeleteResponse]
+      #
+      # @see ModerationAPI::Models::AuthorDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["authors/%1$s", id],
+          model: ModerationAPI::Models::AuthorDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/content.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Content
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::ContentSubmitParams} for more details.
+      #
+      # @overload submit(content:, author_id: nil, channel: nil, content_id: nil, conversation_id: nil, do_not_store: nil, metadata: nil, meta_type: nil, policies: nil, request_options: {})
+      #
+      # @param content [ModerationAPI::Models::ContentSubmitParams::Content::Text, ModerationAPI::Models::ContentSubmitParams::Content::Image, ModerationAPI::Models::ContentSubmitParams::Content::Video, ModerationAPI::Models::ContentSubmitParams::Content::Audio, ModerationAPI::Models::ContentSubmitParams::Content::Object] The content sent for moderation
+      #
+      # @param author_id [String] The author of the content.
+      #
+      # @param channel [String] Provide a channel ID or key. Will use the project's default channel if not provi
+      #
+      # @param content_id [String] The unique ID of the content in your database.
+      #
+      # @param conversation_id [String] For example the ID of a chat room or a post
+      #
+      # @param do_not_store [Boolean] Do not store the content. The content won't enter the review queue
+      #
+      # @param metadata [Hash{Symbol=>Object}] Any metadata you want to store with the content
+      #
+      # @param meta_type [Symbol, ModerationAPI::Models::ContentSubmitParams::MetaType] The meta type of content being moderated
+      #
+      # @param policies [Array<ModerationAPI::Models::ContentSubmitParams::Policy::Toxicity, ModerationAPI::Models::ContentSubmitParams::Policy::PersonalInformation, ModerationAPI::Models::ContentSubmitParams::Policy::ToxicitySevere, ModerationAPI::Models::ContentSubmitParams::Policy::Hate, ModerationAPI::Models::ContentSubmitParams::Policy::Illicit, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitDrugs, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitAlcohol, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitFirearms, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitTobacco, ModerationAPI::Models::ContentSubmitParams::Policy::IllicitGambling, ModerationAPI::Models::ContentSubmitParams::Policy::Sexual, ModerationAPI::Models::ContentSubmitParams::Policy::Flirtation, ModerationAPI::Models::ContentSubmitParams::Policy::Profanity, ModerationAPI::Models::ContentSubmitParams::Policy::Violence, ModerationAPI::Models::ContentSubmitParams::Policy::SelfHarm, ModerationAPI::Models::ContentSubmitParams::Policy::Spam, ModerationAPI::Models::ContentSubmitParams::Policy::SelfPromotion, ModerationAPI::Models::ContentSubmitParams::Policy::Political, ModerationAPI::Models::ContentSubmitParams::Policy::Religion, ModerationAPI::Models::ContentSubmitParams::Policy::CodeAbuse, ModerationAPI::Models::ContentSubmitParams::Policy::PiiMasking, ModerationAPI::Models::ContentSubmitParams::Policy::URLMasking, ModerationAPI::Models::ContentSubmitParams::Policy::Guideline>] (Enterprise) override the channel policies for this moderation request only.
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::ContentSubmitResponse]
+      #
+      # @see ModerationAPI::Models::ContentSubmitParams
+      def submit(params)
+        parsed, options = ModerationAPI::ContentSubmitParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "moderate",
+          body: parsed,
+          model: ModerationAPI::Models::ContentSubmitResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/queue/items.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Queue
+      class Items
+        # Get paginated list of items in a moderation queue with filtering options
+        #
+        # @overload list(id, after_date: nil, author_id: nil, before_date: nil, conversation_ids: nil, filtered_action_ids: nil, include_resolved: nil, labels: nil, page_number: nil, page_size: nil, sort_direction: nil, sort_field: nil, request_options: {})
+        #
+        # @param id [String] The queue ID
+        #
+        # @param after_date [String]
+        #
+        # @param author_id [String]
+        #
+        # @param before_date [String]
+        #
+        # @param conversation_ids [String]
+        #
+        # @param filtered_action_ids [String]
+        #
+        # @param include_resolved [String]
+        #
+        # @param labels [String]
+        #
+        # @param page_number [Float] Page number to fetch
+        #
+        # @param page_size [Float] Number of items per page
+        #
+        # @param sort_direction [Symbol, ModerationAPI::Models::Queue::ItemListParams::SortDirection] Sort direction
+        #
+        # @param sort_field [Symbol, ModerationAPI::Models::Queue::ItemListParams::SortField]
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Queue::ItemListResponse]
+        #
+        # @see ModerationAPI::Models::Queue::ItemListParams
+        def list(id, params = {})
+          parsed, options = ModerationAPI::Queue::ItemListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["queue/%1$s/items", id],
+            query: parsed.transform_keys(
+              after_date: "afterDate",
+              author_id: "authorId",
+              before_date: "beforeDate",
+              conversation_ids: "conversationIds",
+              filtered_action_ids: "filteredActionIds",
+              include_resolved: "includeResolved",
+              page_number: "pageNumber",
+              page_size: "pageSize",
+              sort_direction: "sortDirection",
+              sort_field: "sortField"
+            ),
+            model: ModerationAPI::Models::Queue::ItemListResponse,
+            options: options
+          )
+        end
+
+        # Mark a queue item as resolved with a specific moderation action
+        #
+        # @overload resolve(item_id, id:, comment: nil, request_options: {})
+        #
+        # @param item_id [String] Path param: The item ID to resolve
+        #
+        # @param id [String] Path param: The queue ID
+        #
+        # @param comment [String] Body param: Optional comment
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Queue::ItemResolveResponse]
+        #
+        # @see ModerationAPI::Models::Queue::ItemResolveParams
+        def resolve(item_id, params)
+          parsed, options = ModerationAPI::Queue::ItemResolveParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["queue/%1$s/items/%2$s/resolve", id, item_id],
+            body: parsed,
+            model: ModerationAPI::Models::Queue::ItemResolveResponse,
+            options: options
+          )
+        end
+
+        # Mark a previously resolved queue item as unresolved/pending
+        #
+        # @overload unresolve(item_id, id:, comment: nil, request_options: {})
+        #
+        # @param item_id [String] Path param: The item ID to unresolve
+        #
+        # @param id [String] Path param: The queue ID
+        #
+        # @param comment [String] Body param: Optional reason for unresolving the item
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Queue::ItemUnresolveResponse]
+        #
+        # @see ModerationAPI::Models::Queue::ItemUnresolveParams
+        def unresolve(item_id, params)
+          parsed, options = ModerationAPI::Queue::ItemUnresolveParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["queue/%1$s/items/%2$s/unresolve", id, item_id],
+            body: parsed,
+            model: ModerationAPI::Models::Queue::ItemUnresolveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [ModerationAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/queue.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Queue
+      # @return [ModerationAPI::Resources::Queue::Items]
+      attr_reader :items
+
+      # Get a queue
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The queue ID
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::QueueRetrieveResponse]
+      #
+      # @see ModerationAPI::Models::QueueRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["queue/%1$s", id],
+          model: ModerationAPI::Models::QueueRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get detailed statistics about a moderation queue including review times, action
+      # counts, and trends
+      #
+      # @overload get_stats(id, within_days: nil, request_options: {})
+      #
+      # @param id [String] The queue ID
+      #
+      # @param within_days [String] Number of days to analyze statistics for
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::QueueGetStatsResponse]
+      #
+      # @see ModerationAPI::Models::QueueGetStatsParams
+      def get_stats(id, params = {})
+        parsed, options = ModerationAPI::QueueGetStatsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["queue/%1$s/stats", id],
+          query: parsed.transform_keys(within_days: "withinDays"),
+          model: ModerationAPI::Models::QueueGetStatsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+        @items = ModerationAPI::Resources::Queue::Items.new(client: client)
+      end
+    end
+  end
+end