moderation_api 3.1.1 → 3.2.0

data/lib/moderation_api/models/operations/createwordlist_requestbody.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
+
+      class CreateWordlistRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Name of the wordlist
+        field(
+          :name,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
+        )
+        # Key of the wordlist. Default: made from the name. If the key is already in use, a suffix is added.
+        field(
+          :key,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("key")}}
+        )
+        # Description of the wordlist
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
+        )
+        # Words to add to the wordlist. Words are converted to lowercase. Duplicate and empty words are ignored. Maximum 5000 words.
+        field(
+          :words,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("words")}}
+        )
+
+        sig {
+          params(
+            name: ::String,
+            key: T.nilable(::String),
+            description: T.nilable(::String),
+            words: T.nilable(T::Array[::String])
+          )
+            .void
+        }
+        def initialize(name:, key: nil, description: nil, words: nil)
+          @name = name
+          @key = key
+          @description = description
+          @words = words
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @name == other.name
+          return false unless @key == other.key
+          return false unless @description == other.description
+          return false unless @words == other.words
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::CreateWordlistRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::CreateWordlistRequestBody
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def key
+  end
+
+  def key=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def words
+  end
+
+  def words=(str_)
+  end
+end

data/lib/moderation_api/models/operations/createwordlist_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 CreateWordlistResponse
+        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
+        # Wordlist created successfully
+        field :object, Crystalline::Nilable.new(Models::Operations::CreateWordlistResponseBody)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            object: T.nilable(Models::Operations::CreateWordlistResponseBody)
+          )
+            .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/createwordlist_response.rbi

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

@@ -0,0 +1,90 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Wordlist created successfully
+      class CreateWordlistResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # ID of the wordlist
+        field :id, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("id"), required: true}}
+        # Words in the wordlist
+        field(
+          :words,
+          Crystalline::Array.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("words"), required: true}}
+        )
+        # Creation date of the wordlist
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("createdAt"), required: true}}
+        )
+        # ID of the organization
+        field(
+          :organization_id,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("organizationId"), required: true}}
+        )
+        # Strict mode
+        field(
+          :strict,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("strict"), required: true}}
+        )
+
+        field(
+          :name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
+        )
+
+        field(
+          :user_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("userId"), required: true}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            words: T::Array[::String],
+            created_at: ::String,
+            organization_id: ::String,
+            strict: T::Boolean,
+            name: T.nilable(::String),
+            user_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(id:, words:, created_at:, organization_id:, strict:, name: nil, user_id: nil)
+          @id = id
+          @words = words
+          @created_at = created_at
+          @organization_id = organization_id
+          @strict = strict
+          @name = name
+          @user_id = user_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @words == other.words
+          return false unless @created_at == other.created_at
+          return false unless @organization_id == other.organization_id
+          return false unless @strict == other.strict
+          return false unless @name == other.name
+          return false unless @user_id == other.user_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::CreateWordlistResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::CreateWordlistResponseBody
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def words
+  end
+
+  def words=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def organization_id
+  end
+
+  def organization_id=(str_)
+  end
+
+  def strict
+  end
+
+  def strict=(str_)
+  end
+
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def user_id
+  end
+
+  def user_id=(str_)
+  end
+end

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

@@ -11,20 +11,20 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # Date in YYYY-MM-DD format
+        # Date in YYYY-MM-DD format (UTC).
         field(
           :date,
           ::String,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("date"), required: true}}
         )
-        # Number of reviews on this date
+        # Number of items resolved.
         field(
           :count,
-          ::Float,
+          ::Integer,
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("count"), required: true}}
         )
 
-        sig { params(date: ::String, count: ::Float).void }
+        sig { params(date: ::String, count: ::Integer).void }
         def initialize(date:, count:)
           @date = date
           @count = count

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

@@ -13,7 +13,7 @@ module ModerationApi
 
         # The ID of the action to delete.
         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/deleteauthor_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/deletewebhook_request.rb

@@ -13,7 +13,7 @@ module ModerationApi
 
         # The ID of the webhook to delete.
         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/executeaction_request.rb

@@ -12,7 +12,7 @@ module ModerationApi
         include Crystalline::MetadataFields
 
         field :body, Models::Operations::ExecuteActionRequestBody, {'request': {'media_type': "application/json"}}
-        # 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/flagratespike.rb

@@ -0,0 +1,76 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class FlagRateSpike
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # How many times higher the recent flag rate is than the baseline, for example 2.4.
+        field(
+          :multiple,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("multiple"), required: true}}
+        )
+        # The flag rate in the last 2 days.
+        field(
+          :recent_flag_rate,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("recentFlagRate"), required: true}}
+        )
+        # The flag rate in the 30 days before that.
+        field(
+          :baseline_flag_rate,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("baselineFlagRate"), required: true}}
+        )
+        # Flagged requests in the last 2 days.
+        field(
+          :recent_flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("recentFlagged"), required: true}}
+        )
+        # Requests in the last 2 days.
+        field(
+          :recent_requests,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("recentRequests"), required: true}}
+        )
+
+        sig {
+          params(
+            multiple: ::Float,
+            recent_flag_rate: ::Float,
+            baseline_flag_rate: ::Float,
+            recent_flagged: ::Integer,
+            recent_requests: ::Integer
+          )
+            .void
+        }
+        def initialize(multiple:, recent_flag_rate:, baseline_flag_rate:, recent_flagged:, recent_requests:)
+          @multiple = multiple
+          @recent_flag_rate = recent_flag_rate
+          @baseline_flag_rate = baseline_flag_rate
+          @recent_flagged = recent_flagged
+          @recent_requests = recent_requests
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @multiple == other.multiple
+          return false unless @recent_flag_rate == other.recent_flag_rate
+          return false unless @baseline_flag_rate == other.baseline_flag_rate
+          return false unless @recent_flagged == other.recent_flagged
+          return false unless @recent_requests == other.recent_requests
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::FlagRateSpike
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::FlagRateSpike
+  def multiple
+  end
+
+  def multiple=(str_)
+  end
+
+  def recent_flag_rate
+  end
+
+  def recent_flag_rate=(str_)
+  end
+
+  def baseline_flag_rate
+  end
+
+  def baseline_flag_rate=(str_)
+  end
+
+  def recent_flagged
+  end
+
+  def recent_flagged=(str_)
+  end
+
+  def recent_requests
+  end
+
+  def recent_requests=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getaccount_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/getaction_request.rb

@@ -13,7 +13,7 @@ module ModerationApi
 
         # The ID of the action 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/getanalyticsauthors_author.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 GetAnalyticsAuthorsAuthor
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The author ID from your system. Use it with the authors endpoints.
+        field(
+          :author_id,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("authorId"), required: true}}
+        )
+        # Flagged requests from this author in the window.
+        field(
+          :flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
+        )
+        # The author name, if known.
+        field(
+          :name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
+        )
+
+        sig { params(author_id: ::String, flagged: ::Integer, name: T.nilable(::String)).void }
+        def initialize(author_id:, flagged:, name: nil)
+          @author_id = author_id
+          @flagged = flagged
+          @name = name
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @author_id == other.author_id
+          return false unless @flagged == other.flagged
+          return false unless @name == other.name
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::GetAnalyticsAuthorsAuthor
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::GetAnalyticsAuthorsAuthor
+  def author_id
+  end
+
+  def author_id=(str_)
+  end
+
+  def flagged
+  end
+
+  def flagged=(str_)
+  end
+
+  def name
+  end
+
+  def name=(str_)
+  end
+end

data/lib/moderation_api/models/operations/getanalyticsauthors_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
+      # GetAnalyticsAuthorsQueryParamRange - 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 GetAnalyticsAuthorsQueryParamRange < 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/getanalyticsauthors_queryparam_range.rbi

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

data/lib/moderation_api/models/operations/{casebookanswer.rb → getanalyticsauthors_range_response.rb}

@@ -6,14 +6,14 @@
 module ModerationApi
   module Models
     module Operations
-
-      class CasebookAnswer
+      # GetAnalyticsAuthorsRangeResponse - The time window of the numbers.
+      class GetAnalyticsAuthorsRangeResponse
         include ::Crystalline::Enum
         enums do
-          ALL = new("ALL")
-          ALLOWED = new("ALLOWED")
-          REJECTED = new("REJECTED")
-          NO_ANSWER = new("NO_ANSWER")
+          TWENTY_FOURH = new("24h")
+          SEVEND = new("7d")
+          THIRTYD = new("30d")
+          NINETYD = new("90d")
         end
 
         open!

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

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