moderation_api 1.2.2 → 2.0.1

data/lib/moderation_api/models/queue/item_list_params.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#list
+      class ItemListParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        # @!attribute after_date
+        #
+        #   @return [String, nil]
+        optional :after_date, String
+
+        # @!attribute author_id
+        #
+        #   @return [String, nil]
+        optional :author_id, String
+
+        # @!attribute before_date
+        #
+        #   @return [String, nil]
+        optional :before_date, String
+
+        # @!attribute conversation_ids
+        #
+        #   @return [String, nil]
+        optional :conversation_ids, String
+
+        # @!attribute filtered_action_ids
+        #
+        #   @return [String, nil]
+        optional :filtered_action_ids, String
+
+        # @!attribute include_resolved
+        #
+        #   @return [String, nil]
+        optional :include_resolved, String
+
+        # @!attribute labels
+        #
+        #   @return [String, nil]
+        optional :labels, String
+
+        # @!attribute page_number
+        #   Page number to fetch
+        #
+        #   @return [Float, nil]
+        optional :page_number, Float
+
+        # @!attribute page_size
+        #   Number of items per page
+        #
+        #   @return [Float, nil]
+        optional :page_size, Float
+
+        # @!attribute sort_direction
+        #   Sort direction
+        #
+        #   @return [Symbol, ModerationAPI::Models::Queue::ItemListParams::SortDirection, nil]
+        optional :sort_direction, enum: -> { ModerationAPI::Queue::ItemListParams::SortDirection }
+
+        # @!attribute sort_field
+        #
+        #   @return [Symbol, ModerationAPI::Models::Queue::ItemListParams::SortField, nil]
+        optional :sort_field, enum: -> { ModerationAPI::Queue::ItemListParams::SortField }
+
+        # @!method initialize(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 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}]
+
+        # Sort direction
+        module SortDirection
+          extend ModerationAPI::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module SortField
+          extend ModerationAPI::Internal::Type::Enum
+
+          CREATED_AT = :createdAt
+          SEVERITY = :severity
+          REVIEWED_AT = :reviewedAt
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue/item_list_response.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#list
+      class ItemListResponse < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<ModerationAPI::Models::Queue::ItemListResponse::Item>]
+        required :items,
+                 -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::Queue::ItemListResponse::Item] }
+
+        # @!attribute pagination
+        #
+        #   @return [ModerationAPI::Models::Queue::ItemListResponse::Pagination]
+        required :pagination, -> { ModerationAPI::Models::Queue::ItemListResponse::Pagination }
+
+        # @!method initialize(items:, pagination:)
+        #   @param items [Array<ModerationAPI::Models::Queue::ItemListResponse::Item>]
+        #   @param pagination [ModerationAPI::Models::Queue::ItemListResponse::Pagination]
+
+        class Item < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Content ID
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute content
+          #   The content to be moderated
+          #
+          #   @return [String]
+          required :content, String
+
+          # @!attribute flagged
+          #   Whether the item is flagged by any label
+          #
+          #   @return [Boolean]
+          required :flagged, ModerationAPI::Internal::Type::Boolean
+
+          # @!attribute labels
+          #
+          #   @return [Array<ModerationAPI::Models::Queue::ItemListResponse::Item::Label>]
+          required :labels,
+                   -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::Queue::ItemListResponse::Item::Label] }
+
+          # @!attribute status
+          #   Status of the item
+          #
+          #   @return [Symbol, ModerationAPI::Models::Queue::ItemListResponse::Item::Status]
+          required :status, enum: -> { ModerationAPI::Models::Queue::ItemListResponse::Item::Status }
+
+          # @!attribute timestamp
+          #   Unix timestamp of when the item was created
+          #
+          #   @return [Float]
+          required :timestamp, Float
+
+          # @!attribute actions
+          #   Action IDs taken on this item
+          #
+          #   @return [Array<ModerationAPI::Models::Queue::ItemListResponse::Item::Action>, nil]
+          optional :actions,
+                   -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::Queue::ItemListResponse::Item::Action] }
+
+          # @!attribute author_id
+          #   Author ID
+          #
+          #   @return [String, nil]
+          optional :author_id, String, api_name: :authorId
+
+          # @!attribute content_type
+          #   Type of the content object
+          #
+          #   @return [String, nil]
+          optional :content_type, String, api_name: :contentType
+
+          # @!attribute conversation_id
+          #   Conversation ID
+          #
+          #   @return [String, nil]
+          optional :conversation_id, String, api_name: :conversationId
+
+          # @!attribute language
+          #   Content language
+          #
+          #   @return [String, nil]
+          optional :language, String
+
+          # @!method initialize(id:, content:, flagged:, labels:, status:, timestamp:, actions: nil, author_id: nil, content_type: nil, conversation_id: nil, language: nil)
+          #   @param id [String] Content ID
+          #
+          #   @param content [String] The content to be moderated
+          #
+          #   @param flagged [Boolean] Whether the item is flagged by any label
+          #
+          #   @param labels [Array<ModerationAPI::Models::Queue::ItemListResponse::Item::Label>]
+          #
+          #   @param status [Symbol, ModerationAPI::Models::Queue::ItemListResponse::Item::Status] Status of the item
+          #
+          #   @param timestamp [Float] Unix timestamp of when the item was created
+          #
+          #   @param actions [Array<ModerationAPI::Models::Queue::ItemListResponse::Item::Action>] Action IDs taken on this item
+          #
+          #   @param author_id [String] Author ID
+          #
+          #   @param content_type [String] Type of the content object
+          #
+          #   @param conversation_id [String] Conversation ID
+          #
+          #   @param language [String] Content language
+
+          class Label < ModerationAPI::Internal::Type::BaseModel
+            # @!attribute flagged
+            #   Whether this label caused a flag
+            #
+            #   @return [Boolean]
+            required :flagged, ModerationAPI::Internal::Type::Boolean
+
+            # @!attribute label
+            #   Label name
+            #
+            #   @return [String]
+            required :label, String
+
+            # @!attribute score
+            #   Confidence score of the label
+            #
+            #   @return [Float]
+            required :score, Float
+
+            # @!method initialize(flagged:, label:, score:)
+            #   @param flagged [Boolean] Whether this label caused a flag
+            #
+            #   @param label [String] Label name
+            #
+            #   @param score [Float] Confidence score of the label
+          end
+
+          # Status of the item
+          #
+          # @see ModerationAPI::Models::Queue::ItemListResponse::Item#status
+          module Status
+            extend ModerationAPI::Internal::Type::Enum
+
+            PENDING = :pending
+            RESOLVED = :resolved
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class Action < ModerationAPI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Action ID
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute name
+            #   Action name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute timestamp
+            #   Unix timestamp of when the action was taken
+            #
+            #   @return [Float]
+            required :timestamp, Float
+
+            # @!attribute comment
+            #   Action comment
+            #
+            #   @return [String, nil]
+            optional :comment, String
+
+            # @!attribute reviewer
+            #   Moderator userID
+            #
+            #   @return [String, nil]
+            optional :reviewer, String
+
+            # @!method initialize(id:, name:, timestamp:, comment: nil, reviewer: nil)
+            #   @param id [String] Action ID
+            #
+            #   @param name [String] Action name
+            #
+            #   @param timestamp [Float] Unix timestamp of when the action was taken
+            #
+            #   @param comment [String] Action comment
+            #
+            #   @param reviewer [String] Moderator userID
+          end
+        end
+
+        # @see ModerationAPI::Models::Queue::ItemListResponse#pagination
+        class Pagination < ModerationAPI::Internal::Type::BaseModel
+          # @!attribute current_page
+          #
+          #   @return [Float]
+          required :current_page, Float, api_name: :currentPage
+
+          # @!attribute has_next_page
+          #
+          #   @return [Boolean]
+          required :has_next_page, ModerationAPI::Internal::Type::Boolean, api_name: :hasNextPage
+
+          # @!attribute has_previous_page
+          #
+          #   @return [Boolean]
+          required :has_previous_page, ModerationAPI::Internal::Type::Boolean, api_name: :hasPreviousPage
+
+          # @!attribute total_items
+          #
+          #   @return [Float]
+          required :total_items, Float, api_name: :totalItems
+
+          # @!attribute total_pages
+          #
+          #   @return [Float]
+          required :total_pages, Float, api_name: :totalPages
+
+          # @!method initialize(current_page:, has_next_page:, has_previous_page:, total_items:, total_pages:)
+          #   @param current_page [Float]
+          #   @param has_next_page [Boolean]
+          #   @param has_previous_page [Boolean]
+          #   @param total_items [Float]
+          #   @param total_pages [Float]
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue/item_resolve_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#resolve
+      class ItemResolveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   The queue ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute comment
+        #   Optional comment
+        #
+        #   @return [String, nil]
+        optional :comment, String
+
+        # @!method initialize(id:, comment: nil, request_options: {})
+        #   @param id [String] The queue ID
+        #
+        #   @param comment [String] Optional comment
+        #
+        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue/item_resolve_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#resolve
+      class ItemResolveResponse < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute resolved_at
+        #   Timestamp when the item was resolved
+        #
+        #   @return [String]
+        required :resolved_at, String, api_name: :resolvedAt
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, ModerationAPI::Internal::Type::Boolean
+
+        # @!attribute comment
+        #   Optional comment
+        #
+        #   @return [String, nil]
+        optional :comment, String
+
+        # @!method initialize(resolved_at:, success:, comment: nil)
+        #   @param resolved_at [String] Timestamp when the item was resolved
+        #
+        #   @param success [Boolean]
+        #
+        #   @param comment [String] Optional comment
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue/item_unresolve_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#unresolve
+      class ItemUnresolveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   The queue ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute comment
+        #   Optional reason for unresolving the item
+        #
+        #   @return [String, nil]
+        optional :comment, String
+
+        # @!method initialize(id:, comment: nil, request_options: {})
+        #   @param id [String] The queue ID
+        #
+        #   @param comment [String] Optional reason for unresolving the item
+        #
+        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue/item_unresolve_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    module Queue
+      # @see ModerationAPI::Resources::Queue::Items#unresolve
+      class ItemUnresolveResponse < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute status
+        #   New status of the item
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, ModerationAPI::Internal::Type::Boolean
+
+        # @!attribute unresolved_at
+        #   Timestamp when the item was unresolved
+        #
+        #   @return [String]
+        required :unresolved_at, String, api_name: :unresolvedAt
+
+        # @!method initialize(status:, success:, unresolved_at:)
+        #   @param status [String] New status of the item
+        #
+        #   @param success [Boolean]
+        #
+        #   @param unresolved_at [String] Timestamp when the item was unresolved
+      end
+    end
+  end
+end

data/lib/moderation_api/models/queue_get_stats_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Queue#get_stats
+    class QueueGetStatsParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute within_days
+      #   Number of days to analyze statistics for
+      #
+      #   @return [String, nil]
+      optional :within_days, String
+
+      # @!method initialize(within_days: nil, request_options: {})
+      #   @param within_days [String] Number of days to analyze statistics for
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end