moderation_api 2.41.0 → 3.0.0

data/rbi/moderation_api/resources/webhooks.rbi

@@ -1,105 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Resources
-    class Webhooks
-      # Create a webhook subscribed to one or more event types. Deliveries use the v2
-      # envelope and are signed with the project signing secret (see the signing secret
-      # endpoint).
-      sig do
-        params(
-          event_types:
-            T::Array[ModerationAPI::WebhookCreateParams::EventType::OrSymbol],
-          name: String,
-          url: String,
-          description: T.nilable(String),
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WebhookCreateResponse)
-      end
-      def create(
-        # Event types this webhook subscribes to. One webhook URL receives all events you
-        # list here.
-        event_types:,
-        # The webhook's name, used to identify it in the dashboard
-        name:,
-        # The webhook's URL. We'll call this URL when an event occurs.
-        url:,
-        # The webhook's description
-        description: nil,
-        request_options: {}
-      )
-      end
-
-      # Get a webhook by ID.
-      sig do
-        params(
-          id: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WebhookRetrieveResponse)
-      end
-      def retrieve(
-        # The ID of the webhook to get.
-        id,
-        request_options: {}
-      )
-      end
-
-      # Update a webhook. Legacy v1 webhooks are read-only: delete them and create a new
-      # webhook instead.
-      sig do
-        params(
-          id: String,
-          description: T.nilable(String),
-          event_types:
-            T::Array[ModerationAPI::WebhookUpdateParams::EventType::OrSymbol],
-          name: String,
-          url: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WebhookUpdateResponse)
-      end
-      def update(
-        # The ID of the webhook to update.
-        id,
-        # The webhook's description
-        description: nil,
-        # Event types this webhook subscribes to. One webhook URL receives all events you
-        # list here.
-        event_types: nil,
-        # The webhook's name, used to identify it in the dashboard
-        name: nil,
-        # The webhook's URL. We'll call this URL when an event occurs.
-        url: nil,
-        request_options: {}
-      )
-      end
-
-      # List all webhooks for the authenticated project.
-      sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T::Array[ModerationAPI::Models::WebhookListResponseItem]
-        )
-      end
-      def list(request_options: {})
-      end
-
-      # Delete a webhook.
-      sig do
-        params(
-          id: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WebhookDeleteResponse)
-      end
-      def delete(
-        # The ID of the webhook to delete.
-        id,
-        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/wordlist/words.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Resources
-    class Wordlist
-      class Words
-        # Add words to an existing wordlist
-        sig do
-          params(
-            id: String,
-            words: T::Array[String],
-            request_options: ModerationAPI::RequestOptions::OrHash
-          ).returns(ModerationAPI::Models::Wordlist::WordAddResponse)
-        end
-        def add(
-          # ID of the wordlist to add words to
-          id,
-          # Array of words to add to the wordlist. Duplicate words will be ignored.
-          words:,
-          request_options: {}
-        )
-        end
-
-        # Remove words from an existing wordlist
-        sig do
-          params(
-            id: String,
-            words: T::Array[String],
-            request_options: ModerationAPI::RequestOptions::OrHash
-          ).returns(ModerationAPI::Models::Wordlist::WordRemoveResponse)
-        end
-        def remove(
-          # ID of the wordlist to remove words from
-          id,
-          # Array of words to remove from the wordlist
-          words:,
-          request_options: {}
-        )
-        end
-
-        # @api private
-        sig { params(client: ModerationAPI::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/moderation_api/resources/wordlist.rbi

@@ -1,82 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  module Resources
-    class Wordlist
-      sig { returns(ModerationAPI::Resources::Wordlist::Words) }
-      attr_reader :words
-
-      # Get a specific wordlist by ID
-      sig do
-        params(
-          id: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WordlistRetrieveResponse)
-      end
-      def retrieve(
-        # ID of the wordlist to get
-        id,
-        request_options: {}
-      )
-      end
-
-      # Update a wordlist
-      sig do
-        params(
-          id: String,
-          description: String,
-          key: String,
-          name: String,
-          strict: T::Boolean,
-          words: T::Array[String],
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WordlistUpdateResponse)
-      end
-      def update(
-        # 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
-
-      # List all wordlists for the authenticated organization
-      sig do
-        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
-          T::Array[ModerationAPI::Models::WordlistListResponseItem]
-        )
-      end
-      def list(request_options: {})
-      end
-
-      # Get the current embedding progress status for a wordlist
-      sig do
-        params(
-          id: String,
-          request_options: ModerationAPI::RequestOptions::OrHash
-        ).returns(ModerationAPI::Models::WordlistGetEmbeddingStatusResponse)
-      end
-      def get_embedding_status(
-        # ID of the wordlist to check embedding status for
-        id,
-        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/version.rbi

@@ -1,5 +0,0 @@
-# typed: strong
-
-module ModerationAPI
-  VERSION = T.let(T.unsafe(nil), String)
-end

data/sig/moderation_api/client.rbs

@@ -1,44 +0,0 @@
-module ModerationAPI
-  class Client < ModerationAPI::Internal::Transport::BaseClient
-    DEFAULT_MAX_RETRIES: 2
-
-    DEFAULT_TIMEOUT_IN_SECONDS: Float
-
-    DEFAULT_INITIAL_RETRY_DELAY: Float
-
-    DEFAULT_MAX_RETRY_DELAY: Float
-
-    attr_reader secret_key: String
-
-    attr_reader authors: ModerationAPI::Resources::Authors
-
-    attr_reader queue: ModerationAPI::Resources::Queue
-
-    attr_reader actions: ModerationAPI::Resources::Actions
-
-    attr_reader content: ModerationAPI::Resources::Content
-
-    attr_reader account: ModerationAPI::Resources::Account
-
-    attr_reader auth: ModerationAPI::Resources::Auth
-
-    attr_reader wordlist: ModerationAPI::Resources::Wordlist
-
-    attr_reader webhooks: ModerationAPI::Resources::Webhooks
-
-    attr_reader webhook_secret: ModerationAPI::Resources::WebhookSecret
-
-    private def auth_headers: -> ::Hash[String, String]
-
-    def base_url_overridden?: -> bool
-
-    def initialize: (
-      ?secret_key: String?,
-      ?base_url: String?,
-      ?max_retries: Integer,
-      ?timeout: Float,
-      ?initial_retry_delay: Float,
-      ?max_retry_delay: Float
-    ) -> void
-  end
-end

data/sig/moderation_api/errors.rbs

@@ -1,117 +0,0 @@
-module ModerationAPI
-  module Errors
-    class Error < StandardError
-      attr_accessor cause: StandardError?
-    end
-
-    class ConversionError < ModerationAPI::Errors::Error
-      def cause: -> StandardError?
-
-      def initialize: (
-        on: Class,
-        method: Symbol,
-        target: top,
-        value: top,
-        ?cause: StandardError?
-      ) -> void
-    end
-
-    class APIError < ModerationAPI::Errors::Error
-      attr_accessor url: URI::Generic
-
-      attr_accessor status: Integer?
-
-      attr_accessor headers: ::Hash[String, String]?
-
-      attr_accessor body: top?
-
-      def initialize: (
-        url: URI::Generic,
-        ?status: Integer?,
-        ?headers: ::Hash[String, String]?,
-        ?body: Object?,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APIConnectionError < ModerationAPI::Errors::APIError
-      def initialize: (
-        url: URI::Generic,
-        ?status: nil,
-        ?headers: ::Hash[String, String]?,
-        ?body: nil,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APITimeoutError < ModerationAPI::Errors::APIConnectionError
-      def initialize: (
-        url: URI::Generic,
-        ?status: nil,
-        ?headers: ::Hash[String, String]?,
-        ?body: nil,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APIStatusError < ModerationAPI::Errors::APIError
-      def self.for: (
-        url: URI::Generic,
-        status: Integer,
-        headers: ::Hash[String, String]?,
-        body: Object?,
-        request: nil,
-        response: nil,
-        ?message: String?
-      ) -> instance
-
-      def initialize: (
-        url: URI::Generic,
-        status: Integer,
-        headers: ::Hash[String, String]?,
-        body: Object?,
-        request: nil,
-        response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class BadRequestError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 400
-    end
-
-    class AuthenticationError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 401
-    end
-
-    class PermissionDeniedError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 403
-    end
-
-    class NotFoundError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 404
-    end
-
-    class ConflictError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 409
-    end
-
-    class UnprocessableEntityError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 422
-    end
-
-    class RateLimitError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: 429
-    end
-
-    class InternalServerError < ModerationAPI::Errors::APIStatusError
-      HTTP_STATUS: Range[Integer]
-    end
-  end
-end

data/sig/moderation_api/file_part.rbs

@@ -1,21 +0,0 @@
-module ModerationAPI
-  class FilePart
-    attr_reader content: Pathname | StringIO | IO | String
-
-    attr_reader content_type: String?
-
-    attr_reader filename: String?
-
-    private def read: -> String
-
-    def to_json: (*top a) -> String
-
-    def to_yaml: (*top a) -> String
-
-    def initialize: (
-      Pathname | StringIO | IO | String content,
-      ?filename: (Pathname | String)?,
-      ?content_type: String?
-    ) -> void
-  end
-end

data/sig/moderation_api/internal/transport/base_client.rbs

@@ -1,133 +0,0 @@
-module ModerationAPI
-  module Internal
-    module Transport
-      class BaseClient
-        extend ModerationAPI::Internal::Util::SorbetRuntimeSupport
-
-        type request_components =
-          {
-            method: Symbol,
-            path: String | ::Array[String],
-            query: ::Hash[String, (::Array[String] | String)?]?,
-            headers: ::Hash[String, (String
-            | Integer
-            | ::Array[(String | Integer)?])?]?,
-            body: top?,
-            unwrap: (Symbol
-            | Integer
-            | ::Array[(Symbol | Integer)]
-            | (^(top arg0) -> top))?,
-            page: Class?,
-            stream: Class?,
-            model: ModerationAPI::Internal::Type::Converter::input?,
-            options: ModerationAPI::request_opts?
-          }
-        type request_input =
-          {
-            method: Symbol,
-            url: URI::Generic,
-            headers: ::Hash[String, String],
-            body: top,
-            max_retries: Integer,
-            timeout: Float
-          }
-
-        MAX_REDIRECTS: 20
-
-        PLATFORM_HEADERS: ::Hash[String, String]
-
-        def self.validate!: (
-          ModerationAPI::Internal::Transport::BaseClient::request_components req
-        ) -> void
-
-        def self.should_retry?: (
-          Integer status,
-          headers: ::Hash[String, String]
-        ) -> bool
-
-        def self.follow_redirect: (
-          ModerationAPI::Internal::Transport::BaseClient::request_input request,
-          status: Integer,
-          response_headers: ::Hash[String, String]
-        ) -> ModerationAPI::Internal::Transport::BaseClient::request_input
-
-        def self.reap_connection!: (
-          Integer | ModerationAPI::Errors::APIConnectionError status,
-          stream: Enumerable[String]?
-        ) -> void
-
-        attr_reader base_url: URI::Generic
-
-        attr_reader timeout: Float
-
-        attr_reader max_retries: Integer
-
-        attr_reader initial_retry_delay: Float
-
-        attr_reader max_retry_delay: Float
-
-        attr_reader headers: ::Hash[String, String]
-
-        attr_reader idempotency_header: String?
-
-        # @api private
-        attr_reader requester: ModerationAPI::Internal::Transport::PooledNetRequester
-
-        def initialize: (
-          base_url: String,
-          ?timeout: Float,
-          ?max_retries: Integer,
-          ?initial_retry_delay: Float,
-          ?max_retry_delay: Float,
-          ?headers: ::Hash[String, (String
-          | Integer
-          | ::Array[(String | Integer)?])?],
-          ?idempotency_header: String?
-        ) -> void
-
-        private def auth_headers: -> ::Hash[String, String]
-
-        private def user_agent: -> String
-
-        private def generate_idempotency_key: -> String
-
-        private def build_request: (
-          ModerationAPI::Internal::Transport::BaseClient::request_components req,
-          ModerationAPI::request_options opts
-        ) -> ModerationAPI::Internal::Transport::BaseClient::request_input
-
-        private def retry_delay: (
-          ::Hash[String, String] headers,
-          retry_count: Integer
-        ) -> Float
-
-        def send_request: (
-          ModerationAPI::Internal::Transport::BaseClient::request_input request,
-          redirect_count: Integer,
-          retry_count: Integer,
-          send_retry_header: bool
-        ) -> [Integer, top, Enumerable[String]]
-
-        def request: (
-          Symbol method,
-          String | ::Array[String] path,
-          ?query: ::Hash[String, (::Array[String] | String)?]?,
-          ?headers: ::Hash[String, (String
-          | Integer
-          | ::Array[(String | Integer)?])?]?,
-          ?body: top?,
-          ?unwrap: (Symbol
-          | Integer
-          | ::Array[(Symbol | Integer)]
-          | (^(top arg0) -> top))?,
-          ?page: Class?,
-          ?stream: Class?,
-          ?model: ModerationAPI::Internal::Type::Converter::input?,
-          ?options: ModerationAPI::request_opts?
-        ) -> top
-
-        def inspect: -> String
-      end
-    end
-  end
-end

data/sig/moderation_api/internal/transport/pooled_net_requester.rbs

@@ -1,48 +0,0 @@
-module ModerationAPI
-  module Internal
-    module Transport
-      class PooledNetRequester
-        extend ModerationAPI::Internal::Util::SorbetRuntimeSupport
-
-        type request =
-          {
-            method: Symbol,
-            url: URI::Generic,
-            headers: ::Hash[String, String],
-            body: top,
-            deadline: Float
-          }
-
-        KEEP_ALIVE_TIMEOUT: 30
-
-        DEFAULT_MAX_CONNECTIONS: Integer
-
-        def self.connect: (
-          cert_store: OpenSSL::X509::Store,
-          url: URI::Generic
-        ) -> top
-
-        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
-
-        def self.build_request: (
-          ModerationAPI::Internal::Transport::PooledNetRequester::request request
-        ) {
-          (String arg0) -> void
-        } -> [top, (^-> void)]
-
-        private def with_pool: (
-          URI::Generic url,
-          deadline: Float
-        ) {
-          (top arg0) -> void
-        } -> void
-
-        def execute: (
-          ModerationAPI::Internal::Transport::PooledNetRequester::request request
-        ) -> [Integer, top, Enumerable[String]]
-
-        def initialize: (?size: Integer) -> void
-      end
-    end
-  end
-end

data/sig/moderation_api/internal/type/array_of.rbs

@@ -1,48 +0,0 @@
-module ModerationAPI
-  module Internal
-    module Type
-      class ArrayOf[Elem]
-        include ModerationAPI::Internal::Type::Converter
-        include ModerationAPI::Internal::Util::SorbetRuntimeSupport
-
-        def self.[]: (
-          ::Hash[Symbol, top]
-          | ^-> ModerationAPI::Internal::Type::Converter::input
-          | ModerationAPI::Internal::Type::Converter::input type_info,
-          ?::Hash[Symbol, top] spec
-        ) -> instance
-
-        def ===: (top other) -> bool
-
-        def ==: (top other) -> bool
-
-        def hash: -> Integer
-
-        def coerce: (
-          ::Array[top] | top value,
-          state: ModerationAPI::Internal::Type::Converter::coerce_state
-        ) -> (::Array[top] | top)
-
-        def dump: (
-          ::Array[top] | top value,
-          state: ModerationAPI::Internal::Type::Converter::dump_state
-        ) -> (::Array[top] | top)
-
-        def to_sorbet_type: -> top
-
-        def item_type: -> Elem
-
-        def nilable?: -> bool
-
-        def initialize: (
-          ::Hash[Symbol, top]
-          | ^-> ModerationAPI::Internal::Type::Converter::input
-          | ModerationAPI::Internal::Type::Converter::input type_info,
-          ?::Hash[Symbol, top] spec
-        ) -> void
-
-        def inspect: (?depth: Integer) -> String
-      end
-    end
-  end
-end