moderation_api 3.1.1 → 3.2.0

data/lib/moderation_api/models/operations/getanalyticsautomation_responsebody.rb

@@ -0,0 +1,186 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Successful response
+      class GetAnalyticsAutomationResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The time window of the numbers.
+        field(
+          :range,
+          Models::Operations::GetAnalyticsAutomationRangeResponse,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("range"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::GetAnalyticsAutomationRangeResponse,
+                false
+              )
+            }
+          }
+        )
+        # Flagged requests in the window. Counted on a rolling window from the raw requests, so it can be a little different from the summary.
+        field(
+          :flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
+        )
+        # Flagged requests that a rule allowed or rejected without human review.
+        field(
+          :handled_by_rules,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("handledByRules"), required: true}}
+        )
+        # Flagged requests that the casebook settled without human review.
+        field(
+          :handled_by_casebook,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("handledByCasebook"), required: true}}
+        )
+        # Distinct content items sent to the review queue. Repeats of the same content count once, as in the queue.
+        field(
+          :sent_to_review,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("sentToReview"), required: true}}
+        )
+        # Flagged requests that the review queue merged into an item it already shows: repeats, edits and content that was settled later.
+        field(
+          :merged_duplicates,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("mergedDuplicates"), required: true}}
+        )
+        # Review queue items from this window that a moderator allowed.
+        field(
+          :reviews_allowed,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewsAllowed"), required: true}}
+        )
+        # Review queue items from this window that a moderator rejected.
+        field(
+          :reviews_rejected,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewsRejected"), required: true}}
+        )
+        # Review queue items from this window that a moderator marked as done without allow or reject.
+        field(
+          :reviews_resolved_without_decision,
+          ::Integer,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("reviewsResolvedWithoutDecision"),
+              required: true
+            }
+          }
+        )
+        # Review queue items from this window that are still open.
+        field(
+          :reviews_unresolved,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewsUnresolved"), required: true}}
+        )
+        # Requests where the casebook decision was different from the decision based on severity.
+        field(
+          :casebook_overrulings,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("casebookOverrulings"), required: true}}
+        )
+        # The rules that settled flagged requests without review, largest first. The 5 largest have their own entry. The casebook is one of the rules.
+        field(
+          :rules,
+          Crystalline::Array.new(Models::Operations::Rule),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("rules"), required: true}}
+        )
+        # The channel the numbers are for. Null when they are for all channels.
+        field(
+          :channel_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("channelId"), required: true}}
+        )
+
+        field(
+          :automation_rate,
+          Crystalline::Nilable.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("automationRate"), required: true}}
+        )
+
+        sig {
+          params(
+            range: Models::Operations::GetAnalyticsAutomationRangeResponse,
+            flagged: ::Integer,
+            handled_by_rules: ::Integer,
+            handled_by_casebook: ::Integer,
+            sent_to_review: ::Integer,
+            merged_duplicates: ::Integer,
+            reviews_allowed: ::Integer,
+            reviews_rejected: ::Integer,
+            reviews_resolved_without_decision: ::Integer,
+            reviews_unresolved: ::Integer,
+            casebook_overrulings: ::Integer,
+            rules: T::Array[Models::Operations::Rule],
+            channel_id: T.nilable(::String),
+            automation_rate: T.nilable(::Float)
+          )
+            .void
+        }
+        def initialize(
+          range:,
+          flagged:,
+          handled_by_rules:,
+          handled_by_casebook:,
+          sent_to_review:,
+          merged_duplicates:,
+          reviews_allowed:,
+          reviews_rejected:,
+          reviews_resolved_without_decision:,
+          reviews_unresolved:,
+          casebook_overrulings:,
+          rules:,
+          channel_id: nil,
+          automation_rate: nil
+        )
+          @range = range
+          @flagged = flagged
+          @handled_by_rules = handled_by_rules
+          @handled_by_casebook = handled_by_casebook
+          @sent_to_review = sent_to_review
+          @merged_duplicates = merged_duplicates
+          @reviews_allowed = reviews_allowed
+          @reviews_rejected = reviews_rejected
+          @reviews_resolved_without_decision = reviews_resolved_without_decision
+          @reviews_unresolved = reviews_unresolved
+          @casebook_overrulings = casebook_overrulings
+          @rules = rules
+          @channel_id = channel_id
+          @automation_rate = automation_rate
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @range == other.range
+          return false unless @flagged == other.flagged
+          return false unless @handled_by_rules == other.handled_by_rules
+          return false unless @handled_by_casebook == other.handled_by_casebook
+          return false unless @sent_to_review == other.sent_to_review
+          return false unless @merged_duplicates == other.merged_duplicates
+          return false unless @reviews_allowed == other.reviews_allowed
+          return false unless @reviews_rejected == other.reviews_rejected
+          return false unless @reviews_resolved_without_decision == other.reviews_resolved_without_decision
+          return false unless @reviews_unresolved == other.reviews_unresolved
+          return false unless @casebook_overrulings == other.casebook_overrulings
+          return false unless @rules == other.rules
+          return false unless @channel_id == other.channel_id
+          return false unless @automation_rate == other.automation_rate
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticsautomation_responsebody.rbi

@@ -0,0 +1,92 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsAutomationResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsAutomationResponseBody
+  def range
+  end
+
+  def range=(str_)
+  end
+
+  def flagged
+  end
+
+  def flagged=(str_)
+  end
+
+  def handled_by_rules
+  end
+
+  def handled_by_rules=(str_)
+  end
+
+  def handled_by_casebook
+  end
+
+  def handled_by_casebook=(str_)
+  end
+
+  def sent_to_review
+  end
+
+  def sent_to_review=(str_)
+  end
+
+  def merged_duplicates
+  end
+
+  def merged_duplicates=(str_)
+  end
+
+  def reviews_allowed
+  end
+
+  def reviews_allowed=(str_)
+  end
+
+  def reviews_rejected
+  end
+
+  def reviews_rejected=(str_)
+  end
+
+  def reviews_resolved_without_decision
+  end
+
+  def reviews_resolved_without_decision=(str_)
+  end
+
+  def reviews_unresolved
+  end
+
+  def reviews_unresolved=(str_)
+  end
+
+  def casebook_overrulings
+  end
+
+  def casebook_overrulings=(str_)
+  end
+
+  def rules
+  end
+
+  def rules=(str_)
+  end
+
+  def channel_id
+  end
+
+  def channel_id=(str_)
+  end
+
+  def automation_rate
+  end
+
+  def automation_rate=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_queryparam_range.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # GetAnalyticsChannelsQueryParamRange - The time window. `24h` is the last 24 hours, in hourly buckets. `7d`, `30d` and `90d` are whole UTC days that end with today, in daily buckets.
+      class GetAnalyticsChannelsQueryParamRange < T::Enum
+        enums do
+          TWENTY_FOURH = new("24h")
+          SEVEND = new("7d")
+          THIRTYD = new("30d")
+          NINETYD = new("90d")
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_queryparam_range.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsQueryParamRange
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsQueryParamRange
+end

data/lib/moderation_api/models/operations/getanalyticschannels_range_response.rb

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # GetAnalyticsChannelsRangeResponse - The time window of the numbers.
+      class GetAnalyticsChannelsRangeResponse
+        include ::Crystalline::Enum
+        enums do
+          TWENTY_FOURH = new("24h")
+          SEVEND = new("7d")
+          THIRTYD = new("30d")
+          NINETYD = new("90d")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_range_response.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsRangeResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsRangeResponse
+end

data/lib/moderation_api/models/operations/getanalyticschannels_request.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class GetAnalyticsChannelsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
+        field(
+          :project_id,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
+        )
+        # The time window. `24h` is the last 24 hours, in hourly buckets. `7d`, `30d` and `90d` are whole UTC days that end with today, in daily buckets.
+        field(
+          :range,
+          Crystalline::Nilable.new(Models::Operations::GetAnalyticsChannelsQueryParamRange),
+          {'query_param': {'field_name': "range", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(
+            project_id: T.nilable(::String),
+            range: T.nilable(Models::Operations::GetAnalyticsChannelsQueryParamRange)
+          )
+            .void
+        }
+        def initialize(project_id: nil, range: Models::Operations::GetAnalyticsChannelsQueryParamRange::THIRTYD)
+          @project_id = project_id
+          @range = range
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @project_id == other.project_id
+          return false unless @range == other.range
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_request.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsRequest
+  def project_id
+  end
+
+  def project_id=(str_)
+  end
+
+  def range
+  end
+
+  def range=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_response.rb

@@ -0,0 +1,51 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class GetAnalyticsChannelsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # Successful response
+        field :object, Crystalline::Nilable.new(Models::Operations::GetAnalyticsChannelsResponseBody)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            object: T.nilable(Models::Operations::GetAnalyticsChannelsResponseBody)
+          )
+            .void
+        }
+        def initialize(content_type:, status_code:, raw_response:, object: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @object = object
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @object == other.object
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_response.rbi

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsResponse
+  def content_type
+  end
+
+  def content_type=(str_)
+  end
+
+  def status_code
+  end
+
+  def status_code=(str_)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(str_)
+  end
+
+  def object
+  end
+
+  def object=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_responsebody.rb

@@ -0,0 +1,58 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Successful response
+      class GetAnalyticsChannelsResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The time window of the numbers.
+        field(
+          :range,
+          Models::Operations::GetAnalyticsChannelsRangeResponse,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("range"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::GetAnalyticsChannelsRangeResponse,
+                false
+              )
+            }
+          }
+        )
+        # Requests and flags per channel. Channels with no requests in the window are not included.
+        field(
+          :channels,
+          Crystalline::Array.new(Models::Operations::Channel),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("channels"), required: true}}
+        )
+
+        sig {
+          params(
+            range: Models::Operations::GetAnalyticsChannelsRangeResponse,
+            channels: T::Array[Models::Operations::Channel]
+          )
+            .void
+        }
+        def initialize(range:, channels:)
+          @range = range
+          @channels = channels
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @range == other.range
+          return false unless @channels == other.channels
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/getanalyticschannels_responsebody.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsChannelsResponseBody
+  def range
+  end
+
+  def range=(str_)
+  end
+
+  def channels
+  end
+
+  def channels=(str_)
+  end
+end

data/lib/moderation_api/models/operations/{listqueueitems_label.rb → getanalyticspolicies_policy.rb}

@@ -7,42 +7,42 @@ module ModerationApi
   module Models
     module Operations
 
-      class ListQueueItemsLabel
+      class GetAnalyticsPoliciesPolicy
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # Label name
+        # The policy label, for example `toxicity`.
         field(
           :label,
           ::String,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("label"), required: true}}
         )
-        # Confidence score of the label
-        field(
-          :score,
-          ::Float,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("score"), required: true}}
-        )
-        # Whether this label caused a flag
+        # Flagged requests with this label in the window. Repeats count each time.
         field(
           :flagged,
-          Crystalline::Boolean.new,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
         )
+        # Flagged requests with this label in the window of equal length before.
+        field(
+          :previous_flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("previousFlagged"), required: true}}
+        )
 
-        sig { params(label: ::String, score: ::Float, flagged: T::Boolean).void }
-        def initialize(label:, score:, flagged:)
+        sig { params(label: ::String, flagged: ::Integer, previous_flagged: ::Integer).void }
+        def initialize(label:, flagged:, previous_flagged:)
           @label = label
-          @score = score
           @flagged = flagged
+          @previous_flagged = previous_flagged
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
         def ==(other)
           return false unless other.is_a?(self.class)
           return false unless @label == other.label
-          return false unless @score == other.score
           return false unless @flagged == other.flagged
+          return false unless @previous_flagged == other.previous_flagged
           true
         end
       end

data/lib/moderation_api/models/operations/{listqueueitems_label.rbi → getanalyticspolicies_policy.rbi}

@@ -1,26 +1,26 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::ListQueueItemsLabel
+class ModerationApi::Models::Operations::GetAnalyticsPoliciesPolicy
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::ListQueueItemsLabel
+class ModerationApi::Models::Operations::GetAnalyticsPoliciesPolicy
   def label
   end
 
   def label=(str_)
   end
 
-  def score
+  def flagged
   end
 
-  def score=(str_)
+  def flagged=(str_)
   end
 
-  def flagged
+  def previous_flagged
   end
 
-  def flagged=(str_)
+  def previous_flagged=(str_)
   end
 end

data/lib/moderation_api/models/operations/getanalyticspolicies_queryparam_range.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # GetAnalyticsPoliciesQueryParamRange - The time window. `24h` is the last 24 hours, in hourly buckets. `7d`, `30d` and `90d` are whole UTC days that end with today, in daily buckets.
+      class GetAnalyticsPoliciesQueryParamRange < T::Enum
+        enums do
+          TWENTY_FOURH = new("24h")
+          SEVEND = new("7d")
+          THIRTYD = new("30d")
+          NINETYD = new("90d")
+        end
+      end
+    end
+  end
+end