moderation_api 1.2.2 → 2.0.1

data/lib/moderation_api/models/author_create_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Authors#create
+    class AuthorCreateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute external_id
+      #   External ID of the user, typically the ID of the author in your database.
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute email
+      #   Author email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute external_link
+      #   URL of the author's external profile
+      #
+      #   @return [String, nil]
+      optional :external_link, String, nil?: true
+
+      # @!attribute first_seen
+      #   Timestamp when author first appeared
+      #
+      #   @return [Float, nil]
+      optional :first_seen, Float
+
+      # @!attribute last_seen
+      #   Timestamp of last activity
+      #
+      #   @return [Float, nil]
+      optional :last_seen, Float
+
+      # @!attribute manual_trust_level
+      #
+      #   @return [Float, nil]
+      optional :manual_trust_level, Float, nil?: true
+
+      # @!attribute metadata
+      #   Additional metadata provided by your system. We recommend including any relevant
+      #   information that may assist in the moderation process.
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateParams::Metadata, nil]
+      optional :metadata, -> { ModerationAPI::AuthorCreateParams::Metadata }
+
+      # @!attribute name
+      #   Author name or identifier
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute profile_picture
+      #   URL of the author's profile picture
+      #
+      #   @return [String, nil]
+      optional :profile_picture, String, nil?: true
+
+      # @!method initialize(external_id:, email: nil, external_link: nil, first_seen: nil, last_seen: nil, manual_trust_level: nil, metadata: nil, name: nil, profile_picture: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::AuthorCreateParams} for more details.
+      #
+      #   @param external_id [String] External ID of the user, typically the ID of the author in your database.
+      #
+      #   @param email [String, nil] Author email address
+      #
+      #   @param external_link [String, nil] URL of the author's external profile
+      #
+      #   @param first_seen [Float] Timestamp when author first appeared
+      #
+      #   @param last_seen [Float] Timestamp of last activity
+      #
+      #   @param manual_trust_level [Float, nil]
+      #
+      #   @param metadata [ModerationAPI::Models::AuthorCreateParams::Metadata] Additional metadata provided by your system. We recommend including any relevant
+      #
+      #   @param name [String, nil] Author name or identifier
+      #
+      #   @param profile_picture [String, nil] URL of the author's profile picture
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      class Metadata < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute email_verified
+        #   Whether the author's email is verified
+        #
+        #   @return [Boolean, nil]
+        optional :email_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute identity_verified
+        #   Whether the author's identity is verified
+        #
+        #   @return [Boolean, nil]
+        optional :identity_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute is_paying_customer
+        #   Whether the author is a paying customer
+        #
+        #   @return [Boolean, nil]
+        optional :is_paying_customer, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute phone_verified
+        #   Whether the author's phone number is verified
+        #
+        #   @return [Boolean, nil]
+        optional :phone_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(email_verified: nil, identity_verified: nil, is_paying_customer: nil, phone_verified: nil)
+        #   Additional metadata provided by your system. We recommend including any relevant
+        #   information that may assist in the moderation process.
+        #
+        #   @param email_verified [Boolean, nil] Whether the author's email is verified
+        #
+        #   @param identity_verified [Boolean, nil] Whether the author's identity is verified
+        #
+        #   @param is_paying_customer [Boolean, nil] Whether the author is a paying customer
+        #
+        #   @param phone_verified [Boolean, nil] Whether the author's phone number is verified
+      end
+    end
+  end
+end

data/lib/moderation_api/models/author_create_response.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Authors#create
+    class AuthorCreateResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Author ID in Moderation API
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute block
+      #   Block or suspension details, if applicable. Null if the author is enabled.
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateResponse::Block, nil]
+      required :block, -> { ModerationAPI::Models::AuthorCreateResponse::Block }, nil?: true
+
+      # @!attribute first_seen
+      #   Timestamp when author first appeared
+      #
+      #   @return [Float]
+      required :first_seen, Float
+
+      # @!attribute last_seen
+      #   Timestamp of last activity
+      #
+      #   @return [Float]
+      required :last_seen, Float
+
+      # @!attribute metadata
+      #   Additional metadata provided by your system. We recommend including any relevant
+      #   information that may assist in the moderation process.
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateResponse::Metadata]
+      required :metadata, -> { ModerationAPI::Models::AuthorCreateResponse::Metadata }
+
+      # @!attribute metrics
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateResponse::Metrics]
+      required :metrics, -> { ModerationAPI::Models::AuthorCreateResponse::Metrics }
+
+      # @!attribute risk_evaluation
+      #   Risk assessment details, if available.
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateResponse::RiskEvaluation, nil]
+      required :risk_evaluation, -> { ModerationAPI::Models::AuthorCreateResponse::RiskEvaluation }, nil?: true
+
+      # @!attribute status
+      #   Current author status
+      #
+      #   @return [Symbol, ModerationAPI::Models::AuthorCreateResponse::Status]
+      required :status, enum: -> { ModerationAPI::Models::AuthorCreateResponse::Status }
+
+      # @!attribute trust_level
+      #
+      #   @return [ModerationAPI::Models::AuthorCreateResponse::TrustLevel]
+      required :trust_level, -> { ModerationAPI::Models::AuthorCreateResponse::TrustLevel }
+
+      # @!attribute email
+      #   Author email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute external_id
+      #   The author's ID from your system
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute external_link
+      #   URL of the author's external profile
+      #
+      #   @return [String, nil]
+      optional :external_link, String, nil?: true
+
+      # @!attribute last_incident
+      #   Timestamp of last incident
+      #
+      #   @return [Float, nil]
+      optional :last_incident, Float, nil?: true
+
+      # @!attribute name
+      #   Author name or identifier
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute profile_picture
+      #   URL of the author's profile picture
+      #
+      #   @return [String, nil]
+      optional :profile_picture, String, nil?: true
+
+      # @!method initialize(id:, block:, first_seen:, last_seen:, metadata:, metrics:, risk_evaluation:, status:, trust_level:, email: nil, external_id: nil, external_link: nil, last_incident: nil, name: nil, profile_picture: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::AuthorCreateResponse} for more details.
+      #
+      #   @param id [String] Author ID in Moderation API
+      #
+      #   @param block [ModerationAPI::Models::AuthorCreateResponse::Block, nil] Block or suspension details, if applicable. Null if the author is enabled.
+      #
+      #   @param first_seen [Float] Timestamp when author first appeared
+      #
+      #   @param last_seen [Float] Timestamp of last activity
+      #
+      #   @param metadata [ModerationAPI::Models::AuthorCreateResponse::Metadata] Additional metadata provided by your system. We recommend including any relevant
+      #
+      #   @param metrics [ModerationAPI::Models::AuthorCreateResponse::Metrics]
+      #
+      #   @param risk_evaluation [ModerationAPI::Models::AuthorCreateResponse::RiskEvaluation, nil] Risk assessment details, if available.
+      #
+      #   @param status [Symbol, ModerationAPI::Models::AuthorCreateResponse::Status] Current author status
+      #
+      #   @param trust_level [ModerationAPI::Models::AuthorCreateResponse::TrustLevel]
+      #
+      #   @param email [String, nil] Author email address
+      #
+      #   @param external_id [String, nil] The author's ID from your system
+      #
+      #   @param external_link [String, nil] URL of the author's external profile
+      #
+      #   @param last_incident [Float, nil] Timestamp of last incident
+      #
+      #   @param name [String, nil] Author name or identifier
+      #
+      #   @param profile_picture [String, nil] URL of the author's profile picture
+
+      # @see ModerationAPI::Models::AuthorCreateResponse#block
+      class Block < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute reason
+        #   The moderators reason why the author was blocked or suspended.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute until_
+        #   The timestamp until which they are blocked if the author is suspended.
+        #
+        #   @return [Float, nil]
+        optional :until_, Float, api_name: :until, nil?: true
+
+        # @!method initialize(reason: nil, until_: nil)
+        #   Block or suspension details, if applicable. Null if the author is enabled.
+        #
+        #   @param reason [String, nil] The moderators reason why the author was blocked or suspended.
+        #
+        #   @param until_ [Float, nil] The timestamp until which they are blocked if the author is suspended.
+      end
+
+      # @see ModerationAPI::Models::AuthorCreateResponse#metadata
+      class Metadata < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute email_verified
+        #   Whether the author's email is verified
+        #
+        #   @return [Boolean, nil]
+        optional :email_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute identity_verified
+        #   Whether the author's identity is verified
+        #
+        #   @return [Boolean, nil]
+        optional :identity_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute is_paying_customer
+        #   Whether the author is a paying customer
+        #
+        #   @return [Boolean, nil]
+        optional :is_paying_customer, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute phone_verified
+        #   Whether the author's phone number is verified
+        #
+        #   @return [Boolean, nil]
+        optional :phone_verified, ModerationAPI::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(email_verified: nil, identity_verified: nil, is_paying_customer: nil, phone_verified: nil)
+        #   Additional metadata provided by your system. We recommend including any relevant
+        #   information that may assist in the moderation process.
+        #
+        #   @param email_verified [Boolean, nil] Whether the author's email is verified
+        #
+        #   @param identity_verified [Boolean, nil] Whether the author's identity is verified
+        #
+        #   @param is_paying_customer [Boolean, nil] Whether the author is a paying customer
+        #
+        #   @param phone_verified [Boolean, nil] Whether the author's phone number is verified
+      end
+
+      # @see ModerationAPI::Models::AuthorCreateResponse#metrics
+      class Metrics < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute flagged_content
+        #   Number of flagged content pieces
+        #
+        #   @return [Float]
+        required :flagged_content, Float
+
+        # @!attribute total_content
+        #   Total pieces of content
+        #
+        #   @return [Float]
+        required :total_content, Float
+
+        # @!attribute average_sentiment
+        #   Average sentiment score of content (-1 to 1). Requires a sentiment model in your
+        #   project.
+        #
+        #   @return [Float, nil]
+        optional :average_sentiment, Float, nil?: true
+
+        # @!method initialize(flagged_content:, total_content:, average_sentiment: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ModerationAPI::Models::AuthorCreateResponse::Metrics} for more details.
+        #
+        #   @param flagged_content [Float] Number of flagged content pieces
+        #
+        #   @param total_content [Float] Total pieces of content
+        #
+        #   @param average_sentiment [Float, nil] Average sentiment score of content (-1 to 1). Requires a sentiment model in your
+      end
+
+      # @see ModerationAPI::Models::AuthorCreateResponse#risk_evaluation
+      class RiskEvaluation < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute risk_level
+        #   Calculated risk level based on more than 10 behavioral signals.
+        #
+        #   @return [Float, nil]
+        optional :risk_level, Float, nil?: true
+
+        # @!method initialize(risk_level: nil)
+        #   Risk assessment details, if available.
+        #
+        #   @param risk_level [Float, nil] Calculated risk level based on more than 10 behavioral signals.
+      end
+
+      # Current author status
+      #
+      # @see ModerationAPI::Models::AuthorCreateResponse#status
+      module Status
+        extend ModerationAPI::Internal::Type::Enum
+
+        ENABLED = :enabled
+        SUSPENDED = :suspended
+        BLOCKED = :blocked
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ModerationAPI::Models::AuthorCreateResponse#trust_level
+      class TrustLevel < ModerationAPI::Internal::Type::BaseModel
+        # @!attribute level
+        #   Author trust level (-1, 0, 1, 2, 3, or 4)
+        #
+        #   @return [Float]
+        required :level, Float
+
+        # @!attribute manual
+        #   True if the trust level was set manually by a moderator
+        #
+        #   @return [Boolean]
+        required :manual, ModerationAPI::Internal::Type::Boolean
+
+        # @!method initialize(level:, manual:)
+        #   @param level [Float] Author trust level (-1, 0, 1, 2, 3, or 4)
+        #
+        #   @param manual [Boolean] True if the trust level was set manually by a moderator
+      end
+    end
+  end
+end

data/lib/moderation_api/models/author_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Authors#delete
+    class AuthorDeleteParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/author_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Authors#delete
+    class AuthorDeleteResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, ModerationAPI::Internal::Type::Boolean
+
+      # @!method initialize(success:)
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/moderation_api/models/author_list_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Authors#list
+    class AuthorListParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute content_types
+      #
+      #   @return [String, nil]
+      optional :content_types, String
+
+      # @!attribute last_active_date
+      #
+      #   @return [String, nil]
+      optional :last_active_date, String
+
+      # @!attribute member_since_date
+      #
+      #   @return [String, nil]
+      optional :member_since_date, String
+
+      # @!attribute page_number
+      #   Page number to fetch
+      #
+      #   @return [Float, nil]
+      optional :page_number, Float
+
+      # @!attribute page_size
+      #   Number of authors per page
+      #
+      #   @return [Float, nil]
+      optional :page_size, Float
+
+      # @!attribute sort_by
+      #
+      #   @return [Symbol, ModerationAPI::Models::AuthorListParams::SortBy, nil]
+      optional :sort_by, enum: -> { ModerationAPI::AuthorListParams::SortBy }
+
+      # @!attribute sort_direction
+      #   Sort direction
+      #
+      #   @return [Symbol, ModerationAPI::Models::AuthorListParams::SortDirection, nil]
+      optional :sort_direction, enum: -> { ModerationAPI::AuthorListParams::SortDirection }
+
+      # @!method initialize(content_types: nil, last_active_date: nil, member_since_date: nil, page_number: nil, page_size: nil, sort_by: nil, sort_direction: nil, request_options: {})
+      #   @param content_types [String]
+      #
+      #   @param last_active_date [String]
+      #
+      #   @param member_since_date [String]
+      #
+      #   @param page_number [Float] Page number to fetch
+      #
+      #   @param page_size [Float] Number of authors per page
+      #
+      #   @param sort_by [Symbol, ModerationAPI::Models::AuthorListParams::SortBy]
+      #
+      #   @param sort_direction [Symbol, ModerationAPI::Models::AuthorListParams::SortDirection] Sort direction
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module SortBy
+        extend ModerationAPI::Internal::Type::Enum
+
+        TRUST_LEVEL = :trustLevel
+        VIOLATION_COUNT = :violationCount
+        REPORT_COUNT = :reportCount
+        MEMBER_SINCE = :memberSince
+        LAST_ACTIVE = :lastActive
+        CONTENT_COUNT = :contentCount
+        FLAGGED_CONTENT_RATIO = :flaggedContentRatio
+        AVERAGE_SENTIMENT = :averageSentiment
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort direction
+      module SortDirection
+        extend ModerationAPI::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end