moderation_api 2.32.0 → 2.34.0

data/rbi/moderation_api/models/webhook_update_params.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookUpdateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::WebhookUpdateParams,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the webhook to update.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The webhook's description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Event types this webhook subscribes to. One webhook URL receives all events you
+      # list here.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[ModerationAPI::WebhookUpdateParams::EventType::OrSymbol]
+          )
+        )
+      end
+      attr_reader :event_types
+
+      sig do
+        params(
+          event_types:
+            T::Array[ModerationAPI::WebhookUpdateParams::EventType::OrSymbol]
+        ).void
+      end
+      attr_writer :event_types
+
+      # The webhook's name, used to identify it in the dashboard
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The webhook's URL. We'll call this URL when an event occurs.
+      sig { returns(T.nilable(String)) }
+      attr_reader :url
+
+      sig { params(url: String).void }
+      attr_writer :url
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            description: T.nilable(String),
+            event_types:
+              T::Array[ModerationAPI::WebhookUpdateParams::EventType::OrSymbol],
+            name: String,
+            url: String,
+            request_options: ModerationAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModerationAPI::WebhookUpdateParams::EventType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUE_ITEM_NEW =
+          T.let(
+            :QUEUE_ITEM_NEW,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_COMPLETED =
+          T.let(
+            :QUEUE_ITEM_COMPLETED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ACTION =
+          T.let(
+            :QUEUE_ITEM_ACTION,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_REJECTED =
+          T.let(
+            :QUEUE_ITEM_REJECTED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ALLOWED =
+          T.let(
+            :QUEUE_ITEM_ALLOWED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_BLOCKED =
+          T.let(
+            :AUTHOR_BLOCKED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_UNBLOCKED =
+          T.let(
+            :AUTHOR_UNBLOCKED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_SUSPENDED =
+          T.let(
+            :AUTHOR_SUSPENDED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_UPDATED =
+          T.let(
+            :AUTHOR_UPDATED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_TRUST_LEVEL_CHANGED =
+          T.let(
+            :AUTHOR_TRUST_LEVEL_CHANGED,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+        AUTHOR_ACTION =
+          T.let(
+            :AUTHOR_ACTION,
+            ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::WebhookUpdateParams::EventType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/webhook_update_response.rbi

@@ -0,0 +1,225 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookUpdateResponse < ModerationAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::Models::WebhookUpdateResponse,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the webhook.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The date the webhook was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      # subscribe via their single deprecated `type` instead.
+      sig do
+        returns(
+          T::Array[
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          ]
+        )
+      end
+      attr_accessor :event_types
+
+      # The webhook's name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      sig do
+        returns(
+          ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::TaggedSymbol
+        )
+      end
+      attr_accessor :payload_version
+
+      # The URL we call when a subscribed event occurs.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # The webhook's description.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig do
+        params(
+          id: String,
+          created_at: String,
+          event_types:
+            T::Array[
+              ModerationAPI::Models::WebhookUpdateResponse::EventType::OrSymbol
+            ],
+          name: String,
+          payload_version:
+            ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::OrSymbol,
+          url: String,
+          description: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the webhook.
+        id:,
+        # The date the webhook was created.
+        created_at:,
+        # Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+        # subscribe via their single deprecated `type` instead.
+        event_types:,
+        # The webhook's name.
+        name:,
+        # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+        # shape and is read-only via this API.
+        payload_version:,
+        # The URL we call when a subscribed event occurs.
+        url:,
+        # The webhook's description.
+        description: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: String,
+            event_types:
+              T::Array[
+                ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+              ],
+            name: String,
+            payload_version:
+              ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::TaggedSymbol,
+            url: String,
+            description: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModerationAPI::Models::WebhookUpdateResponse::EventType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUE_ITEM_NEW =
+          T.let(
+            :QUEUE_ITEM_NEW,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_COMPLETED =
+          T.let(
+            :QUEUE_ITEM_COMPLETED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ACTION =
+          T.let(
+            :QUEUE_ITEM_ACTION,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_REJECTED =
+          T.let(
+            :QUEUE_ITEM_REJECTED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ALLOWED =
+          T.let(
+            :QUEUE_ITEM_ALLOWED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_BLOCKED =
+          T.let(
+            :AUTHOR_BLOCKED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_UNBLOCKED =
+          T.let(
+            :AUTHOR_UNBLOCKED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_SUSPENDED =
+          T.let(
+            :AUTHOR_SUSPENDED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_UPDATED =
+          T.let(
+            :AUTHOR_UPDATED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_TRUST_LEVEL_CHANGED =
+          T.let(
+            :AUTHOR_TRUST_LEVEL_CHANGED,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_ACTION =
+          T.let(
+            :AUTHOR_ACTION,
+            ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::WebhookUpdateResponse::EventType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        V1 =
+          T.let(
+            :V1,
+            ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::TaggedSymbol
+          )
+        V2 =
+          T.let(
+            :V2,
+            ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::WebhookUpdateResponse::PayloadVersion::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models.rbi

@@ -29,6 +29,8 @@ module ModerationAPI
 
   AuthRetrieveParams = ModerationAPI::Models::AuthRetrieveParams
 
+  ContentStreamParams = ModerationAPI::Models::ContentStreamParams
+
   ContentSubmitParams = ModerationAPI::Models::ContentSubmitParams
 
   Queue = ModerationAPI::Models::Queue
@@ -37,8 +39,21 @@ module ModerationAPI
 
   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 =

data/rbi/moderation_api/resources/content.rbi

@@ -3,6 +3,40 @@
 module ModerationAPI
   module Resources
     class Content
+      # Open a WebSocket to moderate live voice/call audio in real time. Speech is
+      # transcribed and each finalized utterance is moderated by your enabled text
+      # policies; you receive a verdict per utterance as it's spoken.
+      #
+      # **This is a WebSocket upgrade, not a regular HTTP call.** The request body below
+      # documents the frames you _send_ over the socket; the `101` response documents
+      # the events you _receive_.
+      #
+      # - **Auth:** `Authorization: Bearer <api_key>` on the upgrade. A missing/invalid
+      #   key closes `4401`; voice not enabled on the plan/channel closes `4403`.
+      # - **Subprotocol:** request `moderationapi.v1`.
+      # - **Flow:** send one `start` frame, then `media` frames as audio arrives, then
+      #   `stop` (or disconnect). You receive `session.started`, `utterance.final` per
+      #   utterance, optional `utterance.partial`/`warning`, and `session.ended`.
+      # - **Close codes:** `1000` normal · `1011` server error · `4400` bad request ·
+      #   `4401` auth failed · `4403` voice not enabled · `4429` concurrency limit.
+      #
+      # See the
+      # [Real-time voice guide](https://docs.moderationapi.com/content-moderation/real-time-voice)
+      # for the full walkthrough and code examples.
+      sig do
+        params(
+          sec_web_socket_protocol:
+            ModerationAPI::ContentStreamParams::SecWebSocketProtocol::OrSymbol,
+          request_options: ModerationAPI::RequestOptions::OrHash
+        ).void
+      end
+      def stream(
+        # Requested subprotocol.
+        sec_web_socket_protocol:,
+        request_options: {}
+      )
+      end
+
       sig do
         params(
           content:

data/rbi/moderation_api/resources/webhook_secret.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module ModerationAPI
+  module Resources
+    class WebhookSecret
+      # Get the signing secret used to sign webhook deliveries for this project,
+      # creating one if none exists yet. Verify deliveries by comparing the
+      # `modapi-signature` header to HMAC-SHA256(raw request body, secret) hex-encoded.
+      sig do
+        params(request_options: ModerationAPI::RequestOptions::OrHash).returns(
+          ModerationAPI::Models::WebhookSecretRetrieveResponse
+        )
+      end
+      def retrieve(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/webhooks.rbi

@@ -0,0 +1,105 @@
+# 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/sig/moderation_api/client.rbs

@@ -24,8 +24,14 @@ module ModerationAPI
 
     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?,

data/sig/moderation_api/models/content_stream_params.rbs

@@ -0,0 +1,36 @@
+module ModerationAPI
+  module Models
+    type content_stream_params =
+      {
+        sec_web_socket_protocol: ModerationAPI::Models::ContentStreamParams::sec_web_socket_protocol
+      }
+      & ModerationAPI::Internal::Type::request_parameters
+
+    class ContentStreamParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      attr_accessor sec_web_socket_protocol: ModerationAPI::Models::ContentStreamParams::sec_web_socket_protocol
+
+      def initialize: (
+        sec_web_socket_protocol: ModerationAPI::Models::ContentStreamParams::sec_web_socket_protocol,
+        ?request_options: ModerationAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        sec_web_socket_protocol: ModerationAPI::Models::ContentStreamParams::sec_web_socket_protocol,
+        request_options: ModerationAPI::RequestOptions
+      }
+
+      type sec_web_socket_protocol = :"moderationapi.v1"
+
+      module SecWebSocketProtocol
+        extend ModerationAPI::Internal::Type::Enum
+
+        MODERATIONAPI_V1: :"moderationapi.v1"
+
+        def self?.values: -> ::Array[ModerationAPI::Models::ContentStreamParams::sec_web_socket_protocol]
+      end
+    end
+  end
+end

data/sig/moderation_api/models/queue_retrieve_response.rbs

@@ -77,7 +77,9 @@ module ModerationAPI
             is_flagged: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::is_flagged,
             labels: ::Array[String],
             languages: ::Array[String],
+            max_severity: Integer,
             media_types: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type],
+            min_severity: Integer,
             recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
             search: ::Array[String],
             within: Float,
@@ -149,12 +151,20 @@ module ModerationAPI
 
           def languages=: (::Array[String]) -> ::Array[String]
 
+          attr_reader max_severity: Integer?
+
+          def max_severity=: (Integer) -> Integer
+
           attr_reader media_types: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type]?
 
           def media_types=: (
             ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type]
           ) -> ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type]
 
+          attr_reader min_severity: Integer?
+
+          def min_severity=: (Integer) -> Integer
+
           attr_reader recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action]?
 
           def recommendation_actions=: (
@@ -191,7 +201,9 @@ module ModerationAPI
             ?is_flagged: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::is_flagged,
             ?labels: ::Array[String],
             ?languages: ::Array[String],
+            ?max_severity: Integer,
             ?media_types: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type],
+            ?min_severity: Integer,
             ?recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
             ?search: ::Array[String],
             ?within: Float,
@@ -214,7 +226,9 @@ module ModerationAPI
             is_flagged: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::is_flagged,
             labels: ::Array[String],
             languages: ::Array[String],
+            max_severity: Integer,
             media_types: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::media_type],
+            min_severity: Integer,
             recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
             search: ::Array[String],
             within: Float,