moderation_api 2.41.0 → 3.0.0

data/rbi/moderation_api/models/wordlist_get_embedding_status_response.rbi

@@ -1,53 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistGetEmbeddingStatusResponse < ModerationAPI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::Models::WordlistGetEmbeddingStatusResponse,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # Percentage of words that have been embedded (0-100)
-      sig { returns(Float) }
-      attr_accessor :progress
-
-      # Number of words still waiting to be embedded
-      sig { returns(Float) }
-      attr_accessor :remaining_words
-
-      # Total number of words in the wordlist
-      sig { returns(Float) }
-      attr_accessor :total_words
-
-      # Embedding status details
-      sig do
-        params(
-          progress: Float,
-          remaining_words: Float,
-          total_words: Float
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Percentage of words that have been embedded (0-100)
-        progress:,
-        # Number of words still waiting to be embedded
-        remaining_words:,
-        # Total number of words in the wordlist
-        total_words:
-      )
-      end
-
-      sig do
-        override.returns(
-          { progress: Float, remaining_words: Float, total_words: Float }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models/wordlist_list_params.rbi

@@ -1,32 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistListParams < ModerationAPI::Internal::Type::BaseModel
-      extend ModerationAPI::Internal::Type::RequestParameters::Converter
-      include ModerationAPI::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::WordlistListParams,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig do
-        override.returns({ request_options: ModerationAPI::RequestOptions })
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models/wordlist_list_response.rbi

@@ -1,80 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistListResponseItem < ModerationAPI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::Models::WordlistListResponseItem,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # Unique identifier of the wordlist
-      sig { returns(String) }
-      attr_accessor :id
-
-      # When the wordlist was created
-      sig { returns(T.nilable(String)) }
-      attr_accessor :created_at
-
-      # Description of the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_accessor :description
-
-      # Name of the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_accessor :name
-
-      # User who created the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_accessor :user_id
-
-      sig do
-        params(
-          id: String,
-          created_at: T.nilable(String),
-          description: T.nilable(String),
-          name: T.nilable(String),
-          user_id: T.nilable(String)
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique identifier of the wordlist
-        id:,
-        # When the wordlist was created
-        created_at:,
-        # Description of the wordlist
-        description:,
-        # Name of the wordlist
-        name:,
-        # User who created the wordlist
-        user_id:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: T.nilable(String),
-            description: T.nilable(String),
-            name: T.nilable(String),
-            user_id: T.nilable(String)
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-
-    WordlistListResponse =
-      T.let(
-        ModerationAPI::Internal::Type::ArrayOf[
-          ModerationAPI::Models::WordlistListResponseItem
-        ],
-        ModerationAPI::Internal::Type::Converter
-      )
-  end
-end

data/rbi/moderation_api/models/wordlist_retrieve_params.rbi

@@ -1,43 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistRetrieveParams < ModerationAPI::Internal::Type::BaseModel
-      extend ModerationAPI::Internal::Type::RequestParameters::Converter
-      include ModerationAPI::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::WordlistRetrieveParams,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # ID of the wordlist to get
-      sig { returns(String) }
-      attr_accessor :id
-
-      sig do
-        params(
-          id: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # ID of the wordlist to get
-        id:,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          { id: String, request_options: ModerationAPI::RequestOptions }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models/wordlist_retrieve_response.rbi

@@ -1,88 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::Models::WordlistRetrieveResponse,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # ID of the wordlist
-      sig { returns(String) }
-      attr_accessor :id
-
-      # Creation date of the wordlist
-      sig { returns(String) }
-      attr_accessor :created_at
-
-      # Name of the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_accessor :name
-
-      # ID of the organization
-      sig { returns(String) }
-      attr_accessor :organization_id
-
-      # Strict mode
-      sig { returns(T::Boolean) }
-      attr_accessor :strict
-
-      # ID of the user
-      sig { returns(T.nilable(String)) }
-      attr_accessor :user_id
-
-      # Words in the wordlist
-      sig { returns(T::Array[String]) }
-      attr_accessor :words
-
-      sig do
-        params(
-          id: String,
-          created_at: String,
-          name: T.nilable(String),
-          organization_id: String,
-          strict: T::Boolean,
-          user_id: T.nilable(String),
-          words: T::Array[String]
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # ID of the wordlist
-        id:,
-        # Creation date of the wordlist
-        created_at:,
-        # Name of the wordlist
-        name:,
-        # ID of the organization
-        organization_id:,
-        # Strict mode
-        strict:,
-        # ID of the user
-        user_id:,
-        # Words in the wordlist
-        words:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: String,
-            name: T.nilable(String),
-            organization_id: String,
-            strict: T::Boolean,
-            user_id: T.nilable(String),
-            words: T::Array[String]
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models/wordlist_update_params.rbi

@@ -1,103 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistUpdateParams < ModerationAPI::Internal::Type::BaseModel
-      extend ModerationAPI::Internal::Type::RequestParameters::Converter
-      include ModerationAPI::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::WordlistUpdateParams,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # ID of the wordlist to update
-      sig { returns(String) }
-      attr_accessor :id
-
-      # New description for the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_reader :description
-
-      sig { params(description: String).void }
-      attr_writer :description
-
-      # New key for the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_reader :key
-
-      sig { params(key: String).void }
-      attr_writer :key
-
-      # New name for the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
-
-      # Deprecated. Now using threshold in project settings.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :strict
-
-      sig { params(strict: T::Boolean).void }
-      attr_writer :strict
-
-      # New words for the wordlist. Replace the existing words with these new ones.
-      # Duplicate words will be ignored.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :words
-
-      sig { params(words: T::Array[String]).void }
-      attr_writer :words
-
-      sig do
-        params(
-          id: String,
-          description: String,
-          key: String,
-          name: String,
-          strict: T::Boolean,
-          words: T::Array[String],
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # ID of the wordlist to update
-        id:,
-        # New description for the wordlist
-        description: nil,
-        # New key for the wordlist
-        key: nil,
-        # New name for the wordlist
-        name: nil,
-        # Deprecated. Now using threshold in project settings.
-        strict: nil,
-        # New words for the wordlist. Replace the existing words with these new ones.
-        # Duplicate words will be ignored.
-        words: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            description: String,
-            key: String,
-            name: String,
-            strict: T::Boolean,
-            words: T::Array[String],
-            request_options: ModerationAPI::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models/wordlist_update_response.rbi

@@ -1,88 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Models
-    class WordlistUpdateResponse < ModerationAPI::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModerationAPI::Models::WordlistUpdateResponse,
-            ModerationAPI::Internal::AnyHash
-          )
-        end
-
-      # ID of the wordlist
-      sig { returns(String) }
-      attr_accessor :id
-
-      # Creation date of the wordlist
-      sig { returns(String) }
-      attr_accessor :created_at
-
-      # Name of the wordlist
-      sig { returns(T.nilable(String)) }
-      attr_accessor :name
-
-      # ID of the organization
-      sig { returns(String) }
-      attr_accessor :organization_id
-
-      # Strict mode
-      sig { returns(T::Boolean) }
-      attr_accessor :strict
-
-      # ID of the user
-      sig { returns(T.nilable(String)) }
-      attr_accessor :user_id
-
-      # Words in the wordlist
-      sig { returns(T::Array[String]) }
-      attr_accessor :words
-
-      sig do
-        params(
-          id: String,
-          created_at: String,
-          name: T.nilable(String),
-          organization_id: String,
-          strict: T::Boolean,
-          user_id: T.nilable(String),
-          words: T::Array[String]
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # ID of the wordlist
-        id:,
-        # Creation date of the wordlist
-        created_at:,
-        # Name of the wordlist
-        name:,
-        # ID of the organization
-        organization_id:,
-        # Strict mode
-        strict:,
-        # ID of the user
-        user_id:,
-        # Words in the wordlist
-        words:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: String,
-            name: T.nilable(String),
-            organization_id: String,
-            strict: T::Boolean,
-            user_id: T.nilable(String),
-            words: T::Array[String]
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/moderation_api/models.rbi

@@ -1,67 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  AccountListParams = ModerationAPI::Models::AccountListParams
-
-  ActionCreateParams = ModerationAPI::Models::ActionCreateParams
-
-  ActionDeleteParams = ModerationAPI::Models::ActionDeleteParams
-
-  ActionListParams = ModerationAPI::Models::ActionListParams
-
-  ActionRetrieveParams = ModerationAPI::Models::ActionRetrieveParams
-
-  Actions = ModerationAPI::Models::Actions
-
-  ActionUpdateParams = ModerationAPI::Models::ActionUpdateParams
-
-  AuthCreateParams = ModerationAPI::Models::AuthCreateParams
-
-  AuthorCreateParams = ModerationAPI::Models::AuthorCreateParams
-
-  AuthorDeleteParams = ModerationAPI::Models::AuthorDeleteParams
-
-  AuthorListParams = ModerationAPI::Models::AuthorListParams
-
-  AuthorRetrieveParams = ModerationAPI::Models::AuthorRetrieveParams
-
-  AuthorUpdateParams = ModerationAPI::Models::AuthorUpdateParams
-
-  AuthRetrieveParams = ModerationAPI::Models::AuthRetrieveParams
-
-  ContentStreamParams = ModerationAPI::Models::ContentStreamParams
-
-  ContentSubmitParams = ModerationAPI::Models::ContentSubmitParams
-
-  Queue = ModerationAPI::Models::Queue
-
-  QueueGetStatsParams = ModerationAPI::Models::QueueGetStatsParams
-
-  QueueRetrieveParams = ModerationAPI::Models::QueueRetrieveParams
-
-  WebhookCreateParams = ModerationAPI::Models::WebhookCreateParams
-
-  WebhookDeleteParams = ModerationAPI::Models::WebhookDeleteParams
-
-  WebhookEvent = ModerationAPI::Models::WebhookEvent
-
-  WebhookListParams = ModerationAPI::Models::WebhookListParams
-
-  WebhookRetrieveParams = ModerationAPI::Models::WebhookRetrieveParams
-
-  WebhookSecretRetrieveParams =
-    ModerationAPI::Models::WebhookSecretRetrieveParams
-
-  WebhookUpdateParams = ModerationAPI::Models::WebhookUpdateParams
-
-  Wordlist = ModerationAPI::Models::Wordlist
-
-  WordlistGetEmbeddingStatusParams =
-    ModerationAPI::Models::WordlistGetEmbeddingStatusParams
-
-  WordlistListParams = ModerationAPI::Models::WordlistListParams
-
-  WordlistRetrieveParams = ModerationAPI::Models::WordlistRetrieveParams
-
-  WordlistUpdateParams = ModerationAPI::Models::WordlistUpdateParams
-end

data/rbi/moderation_api/request_options.rbi

@@ -1,59 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  # Specify HTTP behaviour to use for a specific request. These options supplement
-  # or override those provided at the client level.
-  #
-  # When making a request, you can pass an actual {RequestOptions} instance, or
-  # simply pass a Hash with symbol keys matching the attributes on this class.
-  class RequestOptions < ModerationAPI::Internal::Type::BaseModel
-    OrHash =
-      T.type_alias do
-        T.any(ModerationAPI::RequestOptions, ModerationAPI::Internal::AnyHash)
-      end
-
-    # @api private
-    sig { params(opts: ModerationAPI::RequestOptions::OrHash).void }
-    def self.validate!(opts)
-    end
-
-    # Idempotency key to send with request and all associated retries. Will only be
-    # sent for write requests.
-    sig { returns(T.nilable(String)) }
-    attr_accessor :idempotency_key
-
-    # Extra query params to send with the request. These are `.merge`’d into any
-    # `query` given at the client level.
-    sig do
-      returns(
-        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
-      )
-    end
-    attr_accessor :extra_query
-
-    # Extra headers to send with the request. These are `.merged`’d into any
-    # `extra_headers` given at the client level.
-    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
-    attr_accessor :extra_headers
-
-    # Extra data to send with the request. These are deep merged into any data
-    # generated as part of the normal request.
-    sig { returns(T.nilable(T.anything)) }
-    attr_accessor :extra_body
-
-    # Maximum number of retries to attempt after a failed initial request.
-    sig { returns(T.nilable(Integer)) }
-    attr_accessor :max_retries
-
-    # Request timeout in seconds.
-    sig { returns(T.nilable(Float)) }
-    attr_accessor :timeout
-
-    # Returns a new instance of RequestOptions.
-    sig do
-      params(values: ModerationAPI::Internal::AnyHash).returns(T.attached_class)
-    end
-    def self.new(values = {})
-    end
-  end
-end

data/rbi/moderation_api/resources/account.rbi

@@ -1,21 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Resources
-    class Account
-      # Get account details
-      sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          ModerationAPI::Models::AccountListResponse
-        )
-      end
-      def list(request_options: {})
-      end
-
-      # @api private
-      sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/moderation_api/resources/actions/execute.rbi

@@ -1,69 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Resources
-    class Actions
-      class Execute
-        # Execute a moderation action on one or more content items.
-        sig do
-          params(
-            action_key: String,
-            author_ids: T::Array[String],
-            content_ids: T::Array[String],
-            duration: Float,
-            queue_id: String,
-            value: String,
-            request_options: ModerationAPI::RequestOptions::OrHash
-          ).returns(ModerationAPI::Models::Actions::ExecuteExecuteResponse)
-        end
-        def execute(
-          # ID or key of the action to execute
-          action_key:,
-          # IDs of the authors to apply the action to. Provide this or contentIds.
-          author_ids: nil,
-          # IDs of the content items to apply the action to. Provide this or authorIds.
-          content_ids: nil,
-          # Optional duration in milliseconds for actions with timeouts
-          duration: nil,
-          # Optional queue ID if the action is queue-specific
-          queue_id: nil,
-          # Optional value to provide with the action
-          value: nil,
-          request_options: {}
-        )
-        end
-
-        # Execute an action on a set of content items in a queue.
-        sig do
-          params(
-            action_id: String,
-            author_ids: T::Array[String],
-            content_ids: T::Array[String],
-            queue_id: String,
-            value: String,
-            request_options: ModerationAPI::RequestOptions::OrHash
-          ).returns(ModerationAPI::Models::Actions::ExecuteExecuteByIDResponse)
-        end
-        def execute_by_id(
-          # The ID or key of the action to execute.
-          action_id,
-          # IDs of the authors to apply the action to
-          author_ids: nil,
-          # The IDs of the content items to perform the action on.
-          content_ids: nil,
-          # The ID of the queue the action was performed from if any.
-          queue_id: nil,
-          # The value of the action. Useful to set a reason for the action etc.
-          value: nil,
-          request_options: {}
-        )
-        end
-
-        # @api private
-        sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end