moderation_api 2.41.0 → 3.1.0

data/lib/moderation_api/models/action_update_response.rb

@@ -1,188 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    # @see ModerationAPI::Resources::Actions#update
-    class ActionUpdateResponse < ModerationAPI::Internal::Type::BaseModel
-      # @!attribute id
-      #   The ID of the action.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute built_in
-      #   Whether the action is a built-in action or a custom one.
-      #
-      #   @return [Boolean, nil]
-      required :built_in, ModerationAPI::Internal::Type::Boolean, api_name: :builtIn, nil?: true
-
-      # @!attribute created_at
-      #   The date the action was created.
-      #
-      #   @return [String]
-      required :created_at, String, api_name: :createdAt
-
-      # @!attribute filter_in_queue_ids
-      #   The IDs of the queues the action is available in.
-      #
-      #   @return [Array<String>]
-      required :filter_in_queue_ids,
-               ModerationAPI::Internal::Type::ArrayOf[String],
-               api_name: :filterInQueueIds
-
-      # @!attribute free_text
-      #   Whether the action allows any text to be entered as a value or if it must be one
-      #   of the possible values.
-      #
-      #   @return [Boolean]
-      required :free_text, ModerationAPI::Internal::Type::Boolean, api_name: :freeText
-
-      # @!attribute name
-      #   The name of the action.
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute position
-      #   Show the action in all queues, selected queues or no queues (to use via API
-      #   only).
-      #
-      #   @return [Symbol, ModerationAPI::Models::ActionUpdateResponse::Position]
-      required :position, enum: -> { ModerationAPI::Models::ActionUpdateResponse::Position }
-
-      # @!attribute possible_values
-      #   The possible values of the action. The user will be prompted to select one of
-      #   these values when executing the action.
-      #
-      #   @return [Array<ModerationAPI::Models::ActionUpdateResponse::PossibleValue>]
-      required :possible_values,
-               -> { ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::ActionUpdateResponse::PossibleValue] },
-               api_name: :possibleValues
-
-      # @!attribute queue_behaviour
-      #   Whether the action resolves and removes the item, unresolves and re-add it to
-      #   the queue, or does not change the resolve status.
-      #
-      #   @return [Symbol, ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour]
-      required :queue_behaviour,
-               enum: -> { ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour },
-               api_name: :queueBehaviour
-
-      # @!attribute value_required
-      #   Whether the action requires a value to be executed.
-      #
-      #   @return [Boolean]
-      required :value_required, ModerationAPI::Internal::Type::Boolean, api_name: :valueRequired
-
-      # @!attribute description
-      #   The description of the action.
-      #
-      #   @return [String, nil]
-      optional :description, String, nil?: true
-
-      # @!attribute key
-      #   User defined key of the action.
-      #
-      #   @return [String, nil]
-      optional :key, String, nil?: true
-
-      # @!attribute type
-      #   The type of the action.
-      #
-      #   @return [Symbol, ModerationAPI::Models::ActionUpdateResponse::Type, nil]
-      optional :type, enum: -> { ModerationAPI::Models::ActionUpdateResponse::Type }, nil?: true
-
-      # @!method initialize(id:, built_in:, created_at:, filter_in_queue_ids:, free_text:, name:, position:, possible_values:, queue_behaviour:, value_required:, description: nil, key: nil, type: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ModerationAPI::Models::ActionUpdateResponse} for more details.
-      #
-      #   @param id [String] The ID of the action.
-      #
-      #   @param built_in [Boolean, nil] Whether the action is a built-in action or a custom one.
-      #
-      #   @param created_at [String] The date the action was created.
-      #
-      #   @param filter_in_queue_ids [Array<String>] The IDs of the queues the action is available in.
-      #
-      #   @param free_text [Boolean] Whether the action allows any text to be entered as a value or if it must be one
-      #
-      #   @param name [String] The name of the action.
-      #
-      #   @param position [Symbol, ModerationAPI::Models::ActionUpdateResponse::Position] Show the action in all queues, selected queues or no queues (to use via API only
-      #
-      #   @param possible_values [Array<ModerationAPI::Models::ActionUpdateResponse::PossibleValue>] The possible values of the action. The user will be prompted to select one of th
-      #
-      #   @param queue_behaviour [Symbol, ModerationAPI::Models::ActionUpdateResponse::QueueBehaviour] Whether the action resolves and removes the item, unresolves and re-add it to th
-      #
-      #   @param value_required [Boolean] Whether the action requires a value to be executed.
-      #
-      #   @param description [String, nil] The description of the action.
-      #
-      #   @param key [String, nil] User defined key of the action.
-      #
-      #   @param type [Symbol, ModerationAPI::Models::ActionUpdateResponse::Type, nil] The type of the action.
-
-      # Show the action in all queues, selected queues or no queues (to use via API
-      # only).
-      #
-      # @see ModerationAPI::Models::ActionUpdateResponse#position
-      module Position
-        extend ModerationAPI::Internal::Type::Enum
-
-        ALL_QUEUES = :ALL_QUEUES
-        SOME_QUEUES = :SOME_QUEUES
-        HIDDEN = :HIDDEN
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class PossibleValue < ModerationAPI::Internal::Type::BaseModel
-        # @!attribute value
-        #   The value of the action.
-        #
-        #   @return [String]
-        required :value, String
-
-        # @!method initialize(value:)
-        #   @param value [String] The value of the action.
-      end
-
-      # Whether the action resolves and removes the item, unresolves and re-add it to
-      # the queue, or does not change the resolve status.
-      #
-      # @see ModerationAPI::Models::ActionUpdateResponse#queue_behaviour
-      module QueueBehaviour
-        extend ModerationAPI::Internal::Type::Enum
-
-        REMOVE = :REMOVE
-        ADD = :ADD
-        NO_CHANGE = :NO_CHANGE
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # The type of the action.
-      #
-      # @see ModerationAPI::Models::ActionUpdateResponse#type
-      module Type
-        extend ModerationAPI::Internal::Type::Enum
-
-        AUTHOR_BLOCK = :AUTHOR_BLOCK
-        AUTHOR_BLOCK_TEMP = :AUTHOR_BLOCK_TEMP
-        AUTHOR_UNBLOCK = :AUTHOR_UNBLOCK
-        AUTHOR_DELETE = :AUTHOR_DELETE
-        AUTHOR_REPORT = :AUTHOR_REPORT
-        AUTHOR_WARN = :AUTHOR_WARN
-        AUTHOR_CUSTOM = :AUTHOR_CUSTOM
-        ITEM_REJECT = :ITEM_REJECT
-        ITEM_ALLOW = :ITEM_ALLOW
-        ITEM_CUSTOM = :ITEM_CUSTOM
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/moderation_api/models/actions/execute_execute_by_id_params.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    module Actions
-      # @see ModerationAPI::Resources::Actions::Execute#execute_by_id
-      class ExecuteExecuteByIDParams < ModerationAPI::Internal::Type::BaseModel
-        extend ModerationAPI::Internal::Type::RequestParameters::Converter
-        include ModerationAPI::Internal::Type::RequestParameters
-
-        # @!attribute action_id
-        #   The ID or key of the action to execute.
-        #
-        #   @return [String]
-        required :action_id, String
-
-        # @!attribute author_ids
-        #   IDs of the authors to apply the action to
-        #
-        #   @return [Array<String>, nil]
-        optional :author_ids, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :authorIds
-
-        # @!attribute content_ids
-        #   The IDs of the content items to perform the action on.
-        #
-        #   @return [Array<String>, nil]
-        optional :content_ids, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :contentIds
-
-        # @!attribute queue_id
-        #   The ID of the queue the action was performed from if any.
-        #
-        #   @return [String, nil]
-        optional :queue_id, String, api_name: :queueId
-
-        # @!attribute value
-        #   The value of the action. Useful to set a reason for the action etc.
-        #
-        #   @return [String, nil]
-        optional :value, String
-
-        # @!method initialize(action_id:, author_ids: nil, content_ids: nil, queue_id: nil, value: nil, request_options: {})
-        #   @param action_id [String] The ID or key of the action to execute.
-        #
-        #   @param author_ids [Array<String>] IDs of the authors to apply the action to
-        #
-        #   @param content_ids [Array<String>] The IDs of the content items to perform the action on.
-        #
-        #   @param queue_id [String] The ID of the queue the action was performed from if any.
-        #
-        #   @param value [String] The value of the action. Useful to set a reason for the action etc.
-        #
-        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/moderation_api/models/actions/execute_execute_by_id_response.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    module Actions
-      # @see ModerationAPI::Resources::Actions::Execute#execute_by_id
-      class ExecuteExecuteByIDResponse < ModerationAPI::Internal::Type::BaseModel
-        # @!attribute action_id
-        #   The ID of the action.
-        #
-        #   @return [String]
-        required :action_id, String, api_name: :actionId
-
-        # @!attribute ids
-        #   The IDs of the content items.
-        #
-        #   @return [Array<String>]
-        required :ids, ModerationAPI::Internal::Type::ArrayOf[String]
-
-        # @!attribute success
-        #   Action executed successfully.
-        #
-        #   @return [Boolean]
-        required :success, ModerationAPI::Internal::Type::Boolean
-
-        # @!method initialize(action_id:, ids:, success:)
-        #   @param action_id [String] The ID of the action.
-        #
-        #   @param ids [Array<String>] The IDs of the content items.
-        #
-        #   @param success [Boolean] Action executed successfully.
-      end
-    end
-  end
-end

data/lib/moderation_api/models/actions/execute_execute_params.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    module Actions
-      # @see ModerationAPI::Resources::Actions::Execute#execute
-      class ExecuteExecuteParams < ModerationAPI::Internal::Type::BaseModel
-        extend ModerationAPI::Internal::Type::RequestParameters::Converter
-        include ModerationAPI::Internal::Type::RequestParameters
-
-        # @!attribute action_key
-        #   ID or key of the action to execute
-        #
-        #   @return [String]
-        required :action_key, String, api_name: :actionKey
-
-        # @!attribute author_ids
-        #   IDs of the authors to apply the action to. Provide this or contentIds.
-        #
-        #   @return [Array<String>, nil]
-        optional :author_ids, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :authorIds
-
-        # @!attribute content_ids
-        #   IDs of the content items to apply the action to. Provide this or authorIds.
-        #
-        #   @return [Array<String>, nil]
-        optional :content_ids, ModerationAPI::Internal::Type::ArrayOf[String], api_name: :contentIds
-
-        # @!attribute duration
-        #   Optional duration in milliseconds for actions with timeouts
-        #
-        #   @return [Float, nil]
-        optional :duration, Float
-
-        # @!attribute queue_id
-        #   Optional queue ID if the action is queue-specific
-        #
-        #   @return [String, nil]
-        optional :queue_id, String, api_name: :queueId
-
-        # @!attribute value
-        #   Optional value to provide with the action
-        #
-        #   @return [String, nil]
-        optional :value, String
-
-        # @!method initialize(action_key:, author_ids: nil, content_ids: nil, duration: nil, queue_id: nil, value: nil, request_options: {})
-        #   @param action_key [String] ID or key of the action to execute
-        #
-        #   @param author_ids [Array<String>] IDs of the authors to apply the action to. Provide this or contentIds.
-        #
-        #   @param content_ids [Array<String>] IDs of the content items to apply the action to. Provide this or authorIds.
-        #
-        #   @param duration [Float] Optional duration in milliseconds for actions with timeouts
-        #
-        #   @param queue_id [String] Optional queue ID if the action is queue-specific
-        #
-        #   @param value [String] Optional value to provide with the action
-        #
-        #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/moderation_api/models/actions/execute_execute_response.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    module Actions
-      # @see ModerationAPI::Resources::Actions::Execute#execute
-      class ExecuteExecuteResponse < ModerationAPI::Internal::Type::BaseModel
-        # @!attribute success
-        #   Whether the action was executed successfully
-        #
-        #   @return [Boolean]
-        required :success, ModerationAPI::Internal::Type::Boolean
-
-        # @!method initialize(success:)
-        #   Execution result
-        #
-        #   @param success [Boolean] Whether the action was executed successfully
-      end
-    end
-  end
-end

data/lib/moderation_api/models/auth_create_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    # @see ModerationAPI::Resources::Auth#create
-    class AuthCreateParams < 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/auth_create_response.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    # @see ModerationAPI::Resources::Auth#create
-    class AuthCreateResponse < ModerationAPI::Internal::Type::BaseModel
-      # @!attribute message
-      #   Message of the authentication
-      #
-      #   @return [String]
-      required :message, String
-
-      # @!attribute project
-      #   Name of the authenticated project
-      #
-      #   @return [String]
-      required :project, String
-
-      # @!attribute status
-      #   Status of the authentication
-      #
-      #   @return [String]
-      required :status, String
-
-      # @!method initialize(message:, project:, status:)
-      #   @param message [String] Message of the authentication
-      #
-      #   @param project [String] Name of the authenticated project
-      #
-      #   @param status [String] Status of the authentication
-    end
-  end
-end

data/lib/moderation_api/models/auth_retrieve_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    # @see ModerationAPI::Resources::Auth#retrieve
-    class AuthRetrieveParams < 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/auth_retrieve_response.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ModerationAPI
-  module Models
-    # @see ModerationAPI::Resources::Auth#retrieve
-    class AuthRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
-      # @!attribute message
-      #   Message of the authentication
-      #
-      #   @return [String]
-      required :message, String
-
-      # @!attribute status
-      #   Status of the authentication
-      #
-      #   @return [String]
-      required :status, String
-
-      # @!method initialize(message:, status:)
-      #   @param message [String] Message of the authentication
-      #
-      #   @param status [String] Status of the authentication
-    end
-  end
-end

data/lib/moderation_api/models/author_create_params.rb

@@ -1,135 +0,0 @@
-# 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 company
-      #   The author's company or organization
-      #
-      #   @return [String, nil]
-      optional :company, String, nil?: true
-
-      # @!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:, company: nil, 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 company [String, nil] The author's company or organization
-      #
-      #   @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