moderation_api 3.1.1 → 3.2.0

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

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsSummaryResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsSummaryResponseBody
+  def range
+  end
+
+  def range=(str_)
+  end
+
+  def totals
+  end
+
+  def totals=(str_)
+  end
+
+  def previous_period
+  end
+
+  def previous_period=(str_)
+  end
+
+  def pending_review
+  end
+
+  def pending_review=(str_)
+  end
+
+  def channel_id
+  end
+
+  def channel_id=(str_)
+  end
+
+  def flag_rate_spike
+  end
+
+  def flag_rate_spike=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getanalyticsvolumes_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
+      # GetAnalyticsVolumesQueryParamRange - 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 GetAnalyticsVolumesQueryParamRange < 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/getanalyticsvolumes_queryparam_range.rbi

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

data/lib/moderation_api/models/operations/getanalyticsvolumes_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
+      # GetAnalyticsVolumesRangeResponse - The time window of the numbers.
+      class GetAnalyticsVolumesRangeResponse
+        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/getanalyticsvolumes_range_response.rbi

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

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

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class GetAnalyticsVolumesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :channel,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "channel", 'style': "form", 'explode': true}}
+        )
+        # 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::GetAnalyticsVolumesQueryParamRange),
+          {'query_param': {'field_name': "range", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(
+            channel: T.nilable(::String),
+            project_id: T.nilable(::String),
+            range: T.nilable(Models::Operations::GetAnalyticsVolumesQueryParamRange)
+          )
+            .void
+        }
+        def initialize(
+          channel: nil,
+          project_id: nil,
+          range: Models::Operations::GetAnalyticsVolumesQueryParamRange::THIRTYD
+        )
+          @channel = channel
+          @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 @channel == other.channel
+          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/getanalyticsvolumes_request.rbi

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

data/lib/moderation_api/models/operations/getanalyticsvolumes_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 GetAnalyticsVolumesResponse
+        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::GetAnalyticsVolumesResponseBody)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            object: T.nilable(Models::Operations::GetAnalyticsVolumesResponseBody)
+          )
+            .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/getanalyticsvolumes_response.rbi

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsVolumesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsVolumesResponse
+  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/getanalyticsvolumes_responsebody.rb

@@ -0,0 +1,82 @@
+# 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 GetAnalyticsVolumesResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The time window of the numbers.
+        field(
+          :range,
+          Models::Operations::GetAnalyticsVolumesRangeResponse,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("range"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::GetAnalyticsVolumesRangeResponse,
+                false
+              )
+            }
+          }
+        )
+        # The size of each entry in `volumes`.
+        field(
+          :bucket,
+          Models::Operations::Bucket,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("bucket"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(Models::Operations::Bucket, false)
+            }
+          }
+        )
+        # Counts over time, oldest first. Buckets with no requests are included with zeros.
+        field(
+          :volumes,
+          Crystalline::Array.new(Models::Operations::Volume),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("volumes"), 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}}
+        )
+
+        sig {
+          params(
+            range: Models::Operations::GetAnalyticsVolumesRangeResponse,
+            bucket: Models::Operations::Bucket,
+            volumes: T::Array[Models::Operations::Volume],
+            channel_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(range:, bucket:, volumes:, channel_id: nil)
+          @range = range
+          @bucket = bucket
+          @volumes = volumes
+          @channel_id = channel_id
+        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 @bucket == other.bucket
+          return false unless @volumes == other.volumes
+          return false unless @channel_id == other.channel_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsVolumesResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsVolumesResponseBody
+  def range
+  end
+
+  def range=(str_)
+  end
+
+  def bucket
+  end
+
+  def bucket=(str_)
+  end
+
+  def volumes
+  end
+
+  def volumes=(str_)
+  end
+
+  def channel_id
+  end
+
+  def channel_id=(str_)
+  end
+end

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

@@ -13,7 +13,7 @@ module ModerationApi
 
         # Either external ID or the ID assigned by moderation API.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -11,9 +11,9 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The queue ID
+        # The queue ID.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -13,11 +13,11 @@ module ModerationApi
 
         field(
           :queue,
-          Models::Operations::Queue,
+          Models::Components::QueueWithCounts,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("queue"), required: true}}
         )
 
-        sig { params(queue: Models::Operations::Queue).void }
+        sig { params(queue: Models::Components::QueueWithCounts).void }
         def initialize(queue:)
           @queue = queue
         end

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

@@ -11,9 +11,9 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The queue ID
+        # The queue ID.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -16,13 +16,7 @@ module ModerationApi
           Models::Operations::ReviewStats,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("reviewStats"), required: true}}
         )
-
-        field(
-          :action_stats,
-          Crystalline::Array.new(Models::Operations::ActionStat),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("actionStats"), required: true}}
-        )
-        # List of top reviewers and their statistics
+        # Reviewers with the most resolved items, most first. Up to 10.
         field(
           :top_reviewers,
           Crystalline::Array.new(Models::Operations::TopReviewer),
@@ -38,15 +32,13 @@ module ModerationApi
         sig {
           params(
             review_stats: Models::Operations::ReviewStats,
-            action_stats: T::Array[Models::Operations::ActionStat],
             top_reviewers: T::Array[Models::Operations::TopReviewer],
             trends: Models::Operations::Trends
           )
             .void
         }
-        def initialize(review_stats:, action_stats:, top_reviewers:, trends:)
+        def initialize(review_stats:, top_reviewers:, trends:)
           @review_stats = review_stats
-          @action_stats = action_stats
           @top_reviewers = top_reviewers
           @trends = trends
         end
@@ -55,7 +47,6 @@ module ModerationApi
         def ==(other)
           return false unless other.is_a?(self.class)
           return false unless @review_stats == other.review_stats
-          return false unless @action_stats == other.action_stats
           return false unless @top_reviewers == other.top_reviewers
           return false unless @trends == other.trends
           true

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

@@ -12,12 +12,6 @@ class ModerationApi::Models::Operations::GetQueueStatsResponseBody
   def review_stats=(str_)
   end
 
-  def action_stats
-  end
-
-  def action_stats=(str_)
-  end
-
   def top_reviewers
   end
 

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

@@ -13,7 +13,7 @@ module ModerationApi
 
         # The ID of the webhook to get.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -11,7 +11,7 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -13,7 +13,7 @@ module ModerationApi
 
         # ID of the wordlist to get
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -13,7 +13,7 @@ module ModerationApi
 
         # ID of the wordlist to check embedding status for
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

data/lib/moderation_api/models/operations/{submitcontent_label.rb → label.rb}

@@ -7,7 +7,7 @@ module ModerationApi
   module Models
     module Operations
 
-      class SubmitContentLabel
+      class Label
         extend T::Sig
         include Crystalline::MetadataFields
 

data/lib/moderation_api/models/operations/{submitcontent_label.rbi → label.rbi}

@@ -1,11 +1,11 @@
 # typed: true
 # frozen_string_literal: true
 
-class ModerationApi::Models::Operations::SubmitContentLabel
+class ModerationApi::Models::Operations::Label
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class ModerationApi::Models::Operations::SubmitContentLabel
+class ModerationApi::Models::Operations::Label
   def id
   end
 

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

@@ -16,7 +16,7 @@ module ModerationApi
           Crystalline::Nilable.new(::String),
           {'query_param': {'field_name': "queueId", 'style': "form", 'explode': true}}
         )
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),

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

@@ -28,13 +28,7 @@ module ModerationApi
           Crystalline::Nilable.new(::String),
           {'query_param': {'field_name': "lastActiveDate", 'style': "form", 'explode': true}}
         )
-
-        field(
-          :content_types,
-          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
-          {'query_param': {'field_name': "contentTypes", 'style': "form", 'explode': true}}
-        )
-        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
+        # 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),
@@ -55,7 +49,7 @@ module ModerationApi
         # Sort direction
         field(
           :sort_direction,
-          Crystalline::Nilable.new(Models::Operations::ListAuthorsSortDirection),
+          Crystalline::Nilable.new(Models::Operations::SortDirection),
           {'query_param': {'field_name': "sortDirection", 'style': "form", 'explode': true}}
         )
 
@@ -64,11 +58,10 @@ module ModerationApi
             sort_by: T.nilable(Models::Operations::SortBy),
             member_since_date: T.nilable(::String),
             last_active_date: T.nilable(::String),
-            content_types: T.nilable(T::Array[::String]),
             project_id: T.nilable(::String),
             page: T.nilable(::Integer),
             page_size: T.nilable(::Integer),
-            sort_direction: T.nilable(Models::Operations::ListAuthorsSortDirection)
+            sort_direction: T.nilable(Models::Operations::SortDirection)
           )
             .void
         }
@@ -76,16 +69,14 @@ module ModerationApi
           sort_by: nil,
           member_since_date: nil,
           last_active_date: nil,
-          content_types: nil,
           project_id: nil,
           page: 1,
           page_size: 20,
-          sort_direction: Models::Operations::ListAuthorsSortDirection::DESC
+          sort_direction: Models::Operations::SortDirection::DESC
         )
           @sort_by = sort_by
           @member_since_date = member_since_date
           @last_active_date = last_active_date
-          @content_types = content_types
           @project_id = project_id
           @page = page
           @page_size = page_size
@@ -98,7 +89,6 @@ module ModerationApi
           return false unless @sort_by == other.sort_by
           return false unless @member_since_date == other.member_since_date
           return false unless @last_active_date == other.last_active_date
-          return false unless @content_types == other.content_types
           return false unless @project_id == other.project_id
           return false unless @page == other.page
           return false unless @page_size == other.page_size

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

@@ -24,12 +24,6 @@ class ModerationApi::Models::Operations::ListAuthorsRequest
   def last_active_date=(str_)
   end
 
-  def content_types
-  end
-
-  def content_types=(str_)
-  end
-
   def project_id
   end