moderation_api 2.41.0 → 3.1.0

data/lib/moderation_api/models/components/risk_evaluation.rb

@@ -0,0 +1,35 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class RiskEvaluation
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Calculated risk level based on more than 10 behavioral signals.
+        field(
+          :risk_level,
+          Crystalline::Nilable.new(::Float),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("risk_level")}}
+        )
+
+        sig { params(risk_level: T.nilable(::Float)).void }
+        def initialize(risk_level: nil)
+          @risk_level = risk_level
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @risk_level == other.risk_level
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/risk_evaluation.rbi

@@ -0,0 +1,14 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::RiskEvaluation
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::RiskEvaluation
+  def risk_level
+  end
+
+  def risk_level=(str_)
+  end
+end

data/lib/moderation_api/models/components/security.rb

@@ -0,0 +1,34 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class Security
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :secret_key,
+          ::String,
+          {'security': {'scheme': true, 'type': "http", 'sub_type': "bearer", 'field_name': "Authorization"}}
+        )
+
+        sig { params(secret_key: ::String).void }
+        def initialize(secret_key:)
+          @secret_key = secret_key
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @secret_key == other.secret_key
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/security.rbi

@@ -0,0 +1,14 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::Security
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::Security
+  def secret_key
+  end
+
+  def secret_key=(str_)
+  end
+end

data/lib/moderation_api/models/components/status.rb

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # Status - Current author status
+      class Status
+        include ::Crystalline::Enum
+        enums do
+          ENABLED = new("enabled")
+          SUSPENDED = new("suspended")
+          BLOCKED = new("blocked")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/status.rbi

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

data/lib/moderation_api/models/components/transcriptionquality.rb

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      # TranscriptionQuality - Trade-off between transcription speed and accuracy.
+      class TranscriptionQuality
+        include ::Crystalline::Enum
+        enums do
+          SPEED = new("SPEED")
+          BALANCED = new("BALANCED")
+          ACCURACY = new("ACCURACY")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/transcriptionquality.rbi

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

data/lib/moderation_api/models/components/trust_level.rb

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+
+      class TrustLevel
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Author trust level (-1, 0, 1, 2, 3, or 4)
+        field(
+          :level,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("level"), required: true}}
+        )
+        # True if the trust level was set manually by a moderator
+        field(
+          :manual,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("manual"), required: true}}
+        )
+
+        sig { params(level: ::Float, manual: T::Boolean).void }
+        def initialize(level:, manual:)
+          @level = level
+          @manual = manual
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @level == other.level
+          return false unless @manual == other.manual
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/components/trust_level.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Components::TrustLevel
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Components::TrustLevel
+  def level
+  end
+
+  def level=(str_)
+  end
+
+  def manual
+  end
+
+  def manual=(str_)
+  end
+end

data/lib/moderation_api/models/components.rb

@@ -0,0 +1,40 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Components
+      autoload :AuthenticationErrorCode, "moderation_api/models/components/authenticationerror_code.rb"
+      autoload :BadRequestErrorCode, "moderation_api/models/components/badrequesterror_code.rb"
+      autoload :Channel, "moderation_api/models/components/channel.rb"
+      autoload :ConflictErrorCode, "moderation_api/models/components/conflicterror_code.rb"
+      autoload :ErrorIssue, "moderation_api/models/components/errorissue.rb"
+      autoload :InternalServerErrorCode, "moderation_api/models/components/internalservererror_code.rb"
+      autoload :NotFoundErrorCode, "moderation_api/models/components/notfounderror_code.rb"
+      autoload :Pagination, "moderation_api/models/components/pagination.rb"
+      autoload :PermissionDeniedErrorCode, "moderation_api/models/components/permissiondeniederror_code.rb"
+      autoload :Project, "moderation_api/models/components/project.rb"
+      autoload :ProjectWithKey, "moderation_api/models/components/projectwithkey.rb"
+      autoload(
+        :ProjectWithKeyGlobalFlaggingMode,
+        "moderation_api/models/components/projectwithkey_globalflaggingmode.rb"
+      )
+      autoload :ProjectGlobalFlaggingMode, "moderation_api/models/components/project_globalflaggingmode.rb"
+      autoload :PublicAuthor, "moderation_api/models/components/publicauthor.rb"
+      autoload :RateLimitErrorCode, "moderation_api/models/components/ratelimiterror_code.rb"
+      autoload :Security, "moderation_api/models/components/security.rb"
+      autoload :Block, "moderation_api/models/components/block.rb"
+      autoload :ContentType, "moderation_api/models/components/contenttype.rb"
+      autoload :FlaggingMode, "moderation_api/models/components/flaggingmode.rb"
+      autoload :Metadata, "moderation_api/models/components/metadata.rb"
+      autoload :Metrics, "moderation_api/models/components/metrics.rb"
+      autoload :Path, "moderation_api/models/components/path.rb"
+      autoload :RiskEvaluation, "moderation_api/models/components/risk_evaluation.rb"
+      autoload :Status, "moderation_api/models/components/status.rb"
+      autoload :TranscriptionQuality, "moderation_api/models/components/transcriptionquality.rb"
+      autoload :TrustLevel, "moderation_api/models/components/trust_level.rb"
+    end
+  end
+end

data/lib/moderation_api/models/errors/apierror.rb

@@ -0,0 +1,39 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Errors
+
+      class APIError < StandardError
+        include Crystalline::MetadataFields
+        extend T::Sig
+
+        field :body, T.nilable(::String), {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("body")}}
+        field :raw_response, T.nilable(Faraday::Response), {}
+        field(
+          :status_code,
+          T.nilable(::Integer),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("status_code")}}
+        )
+
+        sig { params(status_code: ::Integer, body: ::String, raw_response: Faraday::Response).void }
+        def initialize(status_code:, body:, raw_response:)
+          @status_code = status_code
+          @body = body
+          @raw_response = raw_response
+        end
+
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @status_code == other.status_code
+          return false unless @body == other.body
+          return false unless @raw_response == other.raw_response
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/errors/apierror.rbi

@@ -0,0 +1,27 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Errors::APIError
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Errors::APIError
+
+  def body
+  end
+
+  def body=(body)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(raw_response)
+  end
+
+  def status_code
+  end
+
+  def status_code=(status_code)
+  end
+end

data/lib/moderation_api/models/errors/authenticationerror.rb

@@ -0,0 +1,120 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Errors
+      # The API key is missing, invalid or revoked.
+      class AuthenticationError < StandardError
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Exactly what went wrong. Stable; safe to branch on. New codes may be added.
+        #
+        # - `unauthorized`: Authentication failed.
+        # - `missing_api_key`: No API key in the `Authorization` header.
+        # - `malformed_api_key`: The `Authorization` header does not contain a valid key format.
+        # - `invalid_api_key`: The API key does not exist or was revoked.
+        field(
+          :code,
+          Models::Components::AuthenticationErrorCode,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("code"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(
+                Models::Components::AuthenticationErrorCode,
+                false
+              )
+            }
+          }
+        )
+        # Human-readable explanation.
+        field(
+          :message,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("message"), required: true}}
+        )
+        # Identifies this request. Include it when you contact support.
+        field(
+          :request_id,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("request_id"), required: true}}
+        )
+        # Documentation for this `code`.
+        field(
+          :doc_url,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("doc_url"), required: true}}
+        )
+        # Broad error category. Stable; safe to switch on.
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+        # Validation problems, when the request body is invalid.
+        field(
+          :issues,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::ErrorIssue)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("issues")}}
+        )
+        # Raw HTTP response; suitable for custom response parsing
+        field(
+          :raw_response,
+          Crystalline::Nilable.new(::Faraday::Response),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("-")}}
+        )
+
+        sig {
+          params(
+            code: Models::Components::AuthenticationErrorCode,
+            message: ::String,
+            request_id: ::String,
+            doc_url: ::String,
+            type: ::String,
+            issues: T.nilable(T::Array[Models::Components::ErrorIssue]),
+            raw_response: T.nilable(::Faraday::Response)
+          )
+            .void
+        }
+        def initialize(
+          code:,
+          message:,
+          request_id:,
+          doc_url:,
+          type: "authentication_error",
+          issues: nil,
+          raw_response: nil
+        )
+          @code = code
+          @message = message
+          @request_id = request_id
+          @doc_url = doc_url
+          unless type == "authentication_error"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "authentication_error"
+          @issues = issues
+          @raw_response = raw_response
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @code == other.code
+          return false unless @message == other.message
+          return false unless @request_id == other.request_id
+          return false unless @doc_url == other.doc_url
+          return false unless @type == other.type
+          return false unless @issues == other.issues
+          return false unless @raw_response == other.raw_response
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/errors/authenticationerror.rbi

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Errors::AuthenticationError
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Errors::AuthenticationError
+  def code
+  end
+
+  def code=(str_)
+  end
+
+  def message
+  end
+
+  def message=(str_)
+  end
+
+  def request_id
+  end
+
+  def request_id=(str_)
+  end
+
+  def doc_url
+  end
+
+  def doc_url=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def issues
+  end
+
+  def issues=(str_)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(str_)
+  end
+end

data/lib/moderation_api/models/errors/badrequesterror.rb

@@ -0,0 +1,116 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Errors
+      # The request is malformed or a parameter is invalid.
+      class BadRequestError < StandardError
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Exactly what went wrong. Stable; safe to branch on. New codes may be added.
+        #
+        # - `invalid_request`: A parameter is invalid. `message` says which one.
+        # - `project_id_required`: An organization key called a project endpoint without naming the project in `Project-Id`, and the organization has more than one project.
+        # - `validation_failed`: The request body does not match the schema. `issues` lists each problem with its `path`.
+        field(
+          :code,
+          Models::Components::BadRequestErrorCode,
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("code"),
+              required: true,
+              'decoder': ::ModerationApi::Utils.open_enum_from_string(Models::Components::BadRequestErrorCode, false)
+            }
+          }
+        )
+        # Human-readable explanation.
+        field(
+          :message,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("message"), required: true}}
+        )
+        # Identifies this request. Include it when you contact support.
+        field(
+          :request_id,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("request_id"), required: true}}
+        )
+        # Documentation for this `code`.
+        field(
+          :doc_url,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("doc_url"), required: true}}
+        )
+        # Broad error category. Stable; safe to switch on.
+        field(
+          :type,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("type"), required: true}}
+        )
+        # Validation problems, when the request body is invalid.
+        field(
+          :issues,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::ErrorIssue)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("issues")}}
+        )
+        # Raw HTTP response; suitable for custom response parsing
+        field(
+          :raw_response,
+          Crystalline::Nilable.new(::Faraday::Response),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("-")}}
+        )
+
+        sig {
+          params(
+            code: Models::Components::BadRequestErrorCode,
+            message: ::String,
+            request_id: ::String,
+            doc_url: ::String,
+            type: ::String,
+            issues: T.nilable(T::Array[Models::Components::ErrorIssue]),
+            raw_response: T.nilable(::Faraday::Response)
+          )
+            .void
+        }
+        def initialize(
+          code:,
+          message:,
+          request_id:,
+          doc_url:,
+          type: "invalid_request_error",
+          issues: nil,
+          raw_response: nil
+        )
+          @code = code
+          @message = message
+          @request_id = request_id
+          @doc_url = doc_url
+          unless type == "invalid_request_error"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "invalid_request_error"
+          @issues = issues
+          @raw_response = raw_response
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @code == other.code
+          return false unless @message == other.message
+          return false unless @request_id == other.request_id
+          return false unless @doc_url == other.doc_url
+          return false unless @type == other.type
+          return false unless @issues == other.issues
+          return false unless @raw_response == other.raw_response
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/errors/badrequesterror.rbi

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Errors::BadRequestError
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Errors::BadRequestError
+  def code
+  end
+
+  def code=(str_)
+  end
+
+  def message
+  end
+
+  def message=(str_)
+  end
+
+  def request_id
+  end
+
+  def request_id=(str_)
+  end
+
+  def doc_url
+  end
+
+  def doc_url=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def issues
+  end
+
+  def issues=(str_)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(str_)
+  end
+end