moderation_api 3.1.1 → 3.2.0

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

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

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

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

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

@@ -0,0 +1,71 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class GetAnalyticsPoliciesRequest
+        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::GetAnalyticsPoliciesQueryParamRange),
+          {'query_param': {'field_name': "range", 'style': "form", 'explode': true}}
+        )
+
+        field(
+          :limit,
+          Crystalline::Nilable.new(::Integer),
+          {'query_param': {'field_name': "limit", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(
+            channel: T.nilable(::String),
+            project_id: T.nilable(::String),
+            range: T.nilable(Models::Operations::GetAnalyticsPoliciesQueryParamRange),
+            limit: T.nilable(::Integer)
+          )
+            .void
+        }
+        def initialize(
+          channel: nil,
+          project_id: nil,
+          range: Models::Operations::GetAnalyticsPoliciesQueryParamRange::THIRTYD,
+          limit: 8
+        )
+          @channel = channel
+          @project_id = project_id
+          @range = range
+          @limit = limit
+        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
+          return false unless @limit == other.limit
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

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

@@ -0,0 +1,67 @@
+# 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 GetAnalyticsPoliciesResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The time window of the numbers.
+        field(
+          :range,
+          Models::Operations::GetAnalyticsPoliciesRangeResponse,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("range"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::GetAnalyticsPoliciesRangeResponse,
+                false
+              )
+            }
+          }
+        )
+        # The policy labels with the most flagged requests, largest first.
+        field(
+          :policies,
+          Crystalline::Array.new(Models::Operations::GetAnalyticsPoliciesPolicy),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("policies"), 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::GetAnalyticsPoliciesRangeResponse,
+            policies: T::Array[Models::Operations::GetAnalyticsPoliciesPolicy],
+            channel_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(range:, policies:, channel_id: nil)
+          @range = range
+          @policies = policies
+          @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 @policies == other.policies
+          return false unless @channel_id == other.channel_id
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/moderation_api/models/operations/getanalyticssummary_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
+      # GetAnalyticsSummaryQueryParamRange - 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 GetAnalyticsSummaryQueryParamRange < 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/getanalyticssummary_queryparam_range.rbi

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

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

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

data/lib/moderation_api/models/operations/getanalyticssummary_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 GetAnalyticsSummaryRequest
+        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::GetAnalyticsSummaryQueryParamRange),
+          {'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::GetAnalyticsSummaryQueryParamRange)
+          )
+            .void
+        }
+        def initialize(
+          channel: nil,
+          project_id: nil,
+          range: Models::Operations::GetAnalyticsSummaryQueryParamRange::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/getanalyticssummary_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsSummaryRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsSummaryRequest
+  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/getanalyticssummary_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 GetAnalyticsSummaryResponse
+        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::GetAnalyticsSummaryResponseBody)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            object: T.nilable(Models::Operations::GetAnalyticsSummaryResponseBody)
+          )
+            .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/getanalyticssummary_response.rbi

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

@@ -0,0 +1,94 @@
+# 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 GetAnalyticsSummaryResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The time window of the numbers.
+        field(
+          :range,
+          Models::Operations::GetAnalyticsSummaryRangeResponse,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("range"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Operations::GetAnalyticsSummaryRangeResponse,
+                false
+              )
+            }
+          }
+        )
+        # Request counts for the window. A flagged request has one recommendation: allow, reject or review.
+        field(
+          :totals,
+          Models::Operations::Totals,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("totals"), required: true}}
+        )
+        # The same counts for the window of equal length just before this one. Compare with `totals` to see the trend.
+        field(
+          :previous_period,
+          Models::Operations::PreviousPeriod,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("previousPeriod"), required: true}}
+        )
+        # Items in the default review queue that nobody has reviewed yet, counted as the queue counts them (repeats count once). The queue looks back 30 days, so older items are not included. The range does not change it.
+        field(
+          :pending_review,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("pendingReview"), 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}}
+        )
+        # Set when the flag rate of the last 2 days is at least 2 times the rate of the 30 days before, with at least 50 flagged requests. Null when there is no spike. Always for the full project: the range and channel do not change it.
+        field(
+          :flag_rate_spike,
+          Crystalline::Nilable.new(Models::Operations::FlagRateSpike),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagRateSpike"), required: true}}
+        )
+
+        sig {
+          params(
+            range: Models::Operations::GetAnalyticsSummaryRangeResponse,
+            totals: Models::Operations::Totals,
+            previous_period: Models::Operations::PreviousPeriod,
+            pending_review: ::Integer,
+            channel_id: T.nilable(::String),
+            flag_rate_spike: T.nilable(Models::Operations::FlagRateSpike)
+          )
+            .void
+        }
+        def initialize(range:, totals:, previous_period:, pending_review:, channel_id: nil, flag_rate_spike: nil)
+          @range = range
+          @totals = totals
+          @previous_period = previous_period
+          @pending_review = pending_review
+          @channel_id = channel_id
+          @flag_rate_spike = flag_rate_spike
+        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 @totals == other.totals
+          return false unless @previous_period == other.previous_period
+          return false unless @pending_review == other.pending_review
+          return false unless @channel_id == other.channel_id
+          return false unless @flag_rate_spike == other.flag_rate_spike
+          true
+        end
+      end
+    end
+  end
+end