moderation_api 1.2.1 → 2.0.0

data/sig/moderation_api/models/queue/item_list_params.rbs

@@ -0,0 +1,127 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_list_params =
+        {
+          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::Models::Queue::ItemListParams::sort_direction,
+          sort_field: ModerationAPI::Models::Queue::ItemListParams::sort_field
+        }
+        & ModerationAPI::Internal::Type::request_parameters
+
+      class ItemListParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        attr_reader after_date: String?
+
+        def after_date=: (String) -> String
+
+        attr_reader author_id: String?
+
+        def author_id=: (String) -> String
+
+        attr_reader before_date: String?
+
+        def before_date=: (String) -> String
+
+        attr_reader conversation_ids: String?
+
+        def conversation_ids=: (String) -> String
+
+        attr_reader filtered_action_ids: String?
+
+        def filtered_action_ids=: (String) -> String
+
+        attr_reader include_resolved: String?
+
+        def include_resolved=: (String) -> String
+
+        attr_reader labels: String?
+
+        def labels=: (String) -> String
+
+        attr_reader page_number: Float?
+
+        def page_number=: (Float) -> Float
+
+        attr_reader page_size: Float?
+
+        def page_size=: (Float) -> Float
+
+        attr_reader sort_direction: ModerationAPI::Models::Queue::ItemListParams::sort_direction?
+
+        def sort_direction=: (
+          ModerationAPI::Models::Queue::ItemListParams::sort_direction
+        ) -> ModerationAPI::Models::Queue::ItemListParams::sort_direction
+
+        attr_reader sort_field: ModerationAPI::Models::Queue::ItemListParams::sort_field?
+
+        def sort_field=: (
+          ModerationAPI::Models::Queue::ItemListParams::sort_field
+        ) -> ModerationAPI::Models::Queue::ItemListParams::sort_field
+
+        def initialize: (
+          ?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::Models::Queue::ItemListParams::sort_direction,
+          ?sort_field: ModerationAPI::Models::Queue::ItemListParams::sort_field,
+          ?request_options: ModerationAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          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::Models::Queue::ItemListParams::sort_direction,
+          sort_field: ModerationAPI::Models::Queue::ItemListParams::sort_field,
+          request_options: ModerationAPI::RequestOptions
+        }
+
+        type sort_direction = :asc | :desc
+
+        module SortDirection
+          extend ModerationAPI::Internal::Type::Enum
+
+          ASC: :asc
+          DESC: :desc
+
+          def self?.values: -> ::Array[ModerationAPI::Models::Queue::ItemListParams::sort_direction]
+        end
+
+        type sort_field = :createdAt | :severity | :reviewedAt
+
+        module SortField
+          extend ModerationAPI::Internal::Type::Enum
+
+          CREATED_AT: :createdAt
+          SEVERITY: :severity
+          REVIEWED_AT: :reviewedAt
+
+          def self?.values: -> ::Array[ModerationAPI::Models::Queue::ItemListParams::sort_field]
+        end
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue/item_list_response.rbs

@@ -0,0 +1,209 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_list_response =
+        {
+          items: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item],
+          pagination: ModerationAPI::Models::Queue::ItemListResponse::Pagination
+        }
+
+      class ItemListResponse < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor items: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item]
+
+        attr_accessor pagination: ModerationAPI::Models::Queue::ItemListResponse::Pagination
+
+        def initialize: (
+          items: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item],
+          pagination: ModerationAPI::Models::Queue::ItemListResponse::Pagination
+        ) -> void
+
+        def to_hash: -> {
+          items: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item],
+          pagination: ModerationAPI::Models::Queue::ItemListResponse::Pagination
+        }
+
+        type item =
+          {
+            id: String,
+            content: String,
+            flagged: bool,
+            labels: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Label],
+            status: ModerationAPI::Models::Queue::ItemListResponse::Item::status,
+            timestamp: Float,
+            actions: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action],
+            author_id: String,
+            content_type: String,
+            conversation_id: String,
+            language: String
+          }
+
+        class Item < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor content: String
+
+          attr_accessor flagged: bool
+
+          attr_accessor labels: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Label]
+
+          attr_accessor status: ModerationAPI::Models::Queue::ItemListResponse::Item::status
+
+          attr_accessor timestamp: Float
+
+          attr_reader actions: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action]?
+
+          def actions=: (
+            ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action]
+          ) -> ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action]
+
+          attr_reader author_id: String?
+
+          def author_id=: (String) -> String
+
+          attr_reader content_type: String?
+
+          def content_type=: (String) -> String
+
+          attr_reader conversation_id: String?
+
+          def conversation_id=: (String) -> String
+
+          attr_reader language: String?
+
+          def language=: (String) -> String
+
+          def initialize: (
+            id: String,
+            content: String,
+            flagged: bool,
+            labels: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Label],
+            status: ModerationAPI::Models::Queue::ItemListResponse::Item::status,
+            timestamp: Float,
+            ?actions: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action],
+            ?author_id: String,
+            ?content_type: String,
+            ?conversation_id: String,
+            ?language: String
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            content: String,
+            flagged: bool,
+            labels: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Label],
+            status: ModerationAPI::Models::Queue::ItemListResponse::Item::status,
+            timestamp: Float,
+            actions: ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::Action],
+            author_id: String,
+            content_type: String,
+            conversation_id: String,
+            language: String
+          }
+
+          type label = { flagged: bool, label: String, score: Float }
+
+          class Label < ModerationAPI::Internal::Type::BaseModel
+            attr_accessor flagged: bool
+
+            attr_accessor label: String
+
+            attr_accessor score: Float
+
+            def initialize: (flagged: bool, label: String, score: Float) -> void
+
+            def to_hash: -> { flagged: bool, label: String, score: Float }
+          end
+
+          type status = :pending | :resolved
+
+          module Status
+            extend ModerationAPI::Internal::Type::Enum
+
+            PENDING: :pending
+            RESOLVED: :resolved
+
+            def self?.values: -> ::Array[ModerationAPI::Models::Queue::ItemListResponse::Item::status]
+          end
+
+          type action =
+            {
+              id: String,
+              name: String,
+              timestamp: Float,
+              comment: String,
+              reviewer: String
+            }
+
+          class Action < ModerationAPI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor name: String
+
+            attr_accessor timestamp: Float
+
+            attr_reader comment: String?
+
+            def comment=: (String) -> String
+
+            attr_reader reviewer: String?
+
+            def reviewer=: (String) -> String
+
+            def initialize: (
+              id: String,
+              name: String,
+              timestamp: Float,
+              ?comment: String,
+              ?reviewer: String
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              name: String,
+              timestamp: Float,
+              comment: String,
+              reviewer: String
+            }
+          end
+        end
+
+        type pagination =
+          {
+            current_page: Float,
+            has_next_page: bool,
+            has_previous_page: bool,
+            total_items: Float,
+            total_pages: Float
+          }
+
+        class Pagination < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor current_page: Float
+
+          attr_accessor has_next_page: bool
+
+          attr_accessor has_previous_page: bool
+
+          attr_accessor total_items: Float
+
+          attr_accessor total_pages: Float
+
+          def initialize: (
+            current_page: Float,
+            has_next_page: bool,
+            has_previous_page: bool,
+            total_items: Float,
+            total_pages: Float
+          ) -> void
+
+          def to_hash: -> {
+            current_page: Float,
+            has_next_page: bool,
+            has_previous_page: bool,
+            total_items: Float,
+            total_pages: Float
+          }
+        end
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue/item_resolve_params.rbs

@@ -0,0 +1,32 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_resolve_params =
+        { id: String, comment: String }
+        & ModerationAPI::Internal::Type::request_parameters
+
+      class ItemResolveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader comment: String?
+
+        def comment=: (String) -> String
+
+        def initialize: (
+          id: String,
+          ?comment: String,
+          ?request_options: ModerationAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          comment: String,
+          request_options: ModerationAPI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue/item_resolve_response.rbs

@@ -0,0 +1,26 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_resolve_response =
+        { resolved_at: String, success: bool, comment: String }
+
+      class ItemResolveResponse < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor resolved_at: String
+
+        attr_accessor success: bool
+
+        attr_reader comment: String?
+
+        def comment=: (String) -> String
+
+        def initialize: (
+          resolved_at: String,
+          success: bool,
+          ?comment: String
+        ) -> void
+
+        def to_hash: -> { resolved_at: String, success: bool, comment: String }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue/item_unresolve_params.rbs

@@ -0,0 +1,32 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_unresolve_params =
+        { id: String, comment: String }
+        & ModerationAPI::Internal::Type::request_parameters
+
+      class ItemUnresolveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader comment: String?
+
+        def comment=: (String) -> String
+
+        def initialize: (
+          id: String,
+          ?comment: String,
+          ?request_options: ModerationAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          comment: String,
+          request_options: ModerationAPI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue/item_unresolve_response.rbs

@@ -0,0 +1,24 @@
+module ModerationAPI
+  module Models
+    module Queue
+      type item_unresolve_response =
+        { status: String, success: bool, unresolved_at: String }
+
+      class ItemUnresolveResponse < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor status: String
+
+        attr_accessor success: bool
+
+        attr_accessor unresolved_at: String
+
+        def initialize: (
+          status: String,
+          success: bool,
+          unresolved_at: String
+        ) -> void
+
+        def to_hash: -> { status: String, success: bool, unresolved_at: String }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue_get_stats_params.rbs

@@ -0,0 +1,26 @@
+module ModerationAPI
+  module Models
+    type queue_get_stats_params =
+      { within_days: String }
+      & ModerationAPI::Internal::Type::request_parameters
+
+    class QueueGetStatsParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      attr_reader within_days: String?
+
+      def within_days=: (String) -> String
+
+      def initialize: (
+        ?within_days: String,
+        ?request_options: ModerationAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        within_days: String,
+        request_options: ModerationAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/moderation_api/models/queue_get_stats_response.rbs

@@ -0,0 +1,207 @@
+module ModerationAPI
+  module Models
+    type queue_get_stats_response =
+      {
+        action_stats: ::Array[ModerationAPI::Models::QueueGetStatsResponse::ActionStat],
+        review_stats: ModerationAPI::Models::QueueGetStatsResponse::ReviewStats,
+        top_reviewers: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer],
+        trends: ModerationAPI::Models::QueueGetStatsResponse::Trends
+      }
+
+    class QueueGetStatsResponse < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor action_stats: ::Array[ModerationAPI::Models::QueueGetStatsResponse::ActionStat]
+
+      attr_accessor review_stats: ModerationAPI::Models::QueueGetStatsResponse::ReviewStats
+
+      attr_accessor top_reviewers: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer]
+
+      attr_accessor trends: ModerationAPI::Models::QueueGetStatsResponse::Trends
+
+      def initialize: (
+        action_stats: ::Array[ModerationAPI::Models::QueueGetStatsResponse::ActionStat],
+        review_stats: ModerationAPI::Models::QueueGetStatsResponse::ReviewStats,
+        top_reviewers: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer],
+        trends: ModerationAPI::Models::QueueGetStatsResponse::Trends
+      ) -> void
+
+      def to_hash: -> {
+        action_stats: ::Array[ModerationAPI::Models::QueueGetStatsResponse::ActionStat],
+        review_stats: ModerationAPI::Models::QueueGetStatsResponse::ReviewStats,
+        top_reviewers: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer],
+        trends: ModerationAPI::Models::QueueGetStatsResponse::Trends
+      }
+
+      type action_stat =
+        {
+          action_id: String,
+          action_name: String,
+          count: Float,
+          percentage_of_total: Float
+        }
+
+      class ActionStat < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor action_id: String
+
+        attr_accessor action_name: String
+
+        attr_accessor count: Float
+
+        attr_accessor percentage_of_total: Float
+
+        def initialize: (
+          action_id: String,
+          action_name: String,
+          count: Float,
+          percentage_of_total: Float
+        ) -> void
+
+        def to_hash: -> {
+          action_id: String,
+          action_name: String,
+          count: Float,
+          percentage_of_total: Float
+        }
+      end
+
+      type review_stats =
+        {
+          average_time_to_review: Float,
+          total_pending: Float,
+          total_reviewed: Float
+        }
+
+      class ReviewStats < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor average_time_to_review: Float
+
+        attr_accessor total_pending: Float
+
+        attr_accessor total_reviewed: Float
+
+        def initialize: (
+          average_time_to_review: Float,
+          total_pending: Float,
+          total_reviewed: Float
+        ) -> void
+
+        def to_hash: -> {
+          average_time_to_review: Float,
+          total_pending: Float,
+          total_reviewed: Float
+        }
+      end
+
+      type top_reviewer =
+        {
+          average_time_per_review: Float,
+          name: String,
+          review_count: Float,
+          top_actions: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction],
+          user_id: String,
+          accuracy_score: Float
+        }
+
+      class TopReviewer < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor average_time_per_review: Float
+
+        attr_accessor name: String
+
+        attr_accessor review_count: Float
+
+        attr_accessor top_actions: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction]
+
+        attr_accessor user_id: String
+
+        attr_reader accuracy_score: Float?
+
+        def accuracy_score=: (Float) -> Float
+
+        def initialize: (
+          average_time_per_review: Float,
+          name: String,
+          review_count: Float,
+          top_actions: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction],
+          user_id: String,
+          ?accuracy_score: Float
+        ) -> void
+
+        def to_hash: -> {
+          average_time_per_review: Float,
+          name: String,
+          review_count: Float,
+          top_actions: ::Array[ModerationAPI::Models::QueueGetStatsResponse::TopReviewer::TopAction],
+          user_id: String,
+          accuracy_score: Float
+        }
+
+        type top_action =
+          { action_id: String, action_name: String, count: Float }
+
+        class TopAction < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor action_id: String
+
+          attr_accessor action_name: String
+
+          attr_accessor count: Float
+
+          def initialize: (
+            action_id: String,
+            action_name: String,
+            count: Float
+          ) -> void
+
+          def to_hash: -> {
+            action_id: String,
+            action_name: String,
+            count: Float
+          }
+        end
+      end
+
+      type trends =
+        {
+          daily_review_counts: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount],
+          flagged_content_trends: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend]
+        }
+
+      class Trends < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor daily_review_counts: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount]
+
+        attr_accessor flagged_content_trends: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend]
+
+        def initialize: (
+          daily_review_counts: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount],
+          flagged_content_trends: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend]
+        ) -> void
+
+        def to_hash: -> {
+          daily_review_counts: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::DailyReviewCount],
+          flagged_content_trends: ::Array[ModerationAPI::Models::QueueGetStatsResponse::Trends::FlaggedContentTrend]
+        }
+
+        type daily_review_count = { count: Float, date: String }
+
+        class DailyReviewCount < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor count: Float
+
+          attr_accessor date: String
+
+          def initialize: (count: Float, date: String) -> void
+
+          def to_hash: -> { count: Float, date: String }
+        end
+
+        type flagged_content_trend = { label: String, trend: Float }
+
+        class FlaggedContentTrend < ModerationAPI::Internal::Type::BaseModel
+          attr_accessor label: String
+
+          attr_accessor trend: Float
+
+          def initialize: (label: String, trend: Float) -> void
+
+          def to_hash: -> { label: String, trend: Float }
+        end
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module ModerationAPI
+  module Models
+    type queue_retrieve_params =
+      {  } & ModerationAPI::Internal::Type::request_parameters
+
+    class QueueRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: ModerationAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: ModerationAPI::RequestOptions }
+    end
+  end
+end