moderation_api 2.33.0 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294b476a6ef6e1b027a65e8b2597d4309b42561044836e8c36a227634f0f6534
-  data.tar.gz: 0fe19f2530860dd03131a9bd64f226d089b69a2dec0f0431126352cb69808bc4
+  metadata.gz: b6c81ee2a9da518fa7c2d46dd6de06482739a80d3c7bc72e415c459e049b5118
+  data.tar.gz: 30591937048d8e2662f1b4106fa0a1e1478220759995543efd8305a24e31fbc0
 SHA512:
-  metadata.gz: da98eb385747ee416b4a21a58092e5fe19e5620af0cc29e006e932ba2a07413ccc8cfec0005d000bd073ef3ccaa8d645bb515982eaf89ac7983791d220f076ff
-  data.tar.gz: 8d98d957d5ffe79a5fd31f06052837a33f8780ac43b88be9680bab1415655b2b9eb28a8151f2a10526ccda134a9f5c44eb500e3352f2db1edd6c1352df018ea2
+  metadata.gz: f22f683cf8f5a19e6f672ea2823869a529aae0a159ad30a7eda1e47fb1ca5f2714d1bab28b21b05af334ad8fa645797cf9efbcddf709bfa5f18fb86e13f5140e
+  data.tar.gz: 0e6cd98b619b02bbdcfa571fcae9f9903c8062f95554f1673649c5c8341190c3d321a15fcaffcde5eeb7b1c5fbd87f35f7cfe00e8dd4df04d0db1b4df6786c93

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.34.0 (2026-08-20)
+
+Full Changelog: [v2.33.0...v2.34.0](https://github.com/moderation-api/sdk-ruby/compare/v2.33.0...v2.34.0)
+
+### Features
+
+* **api:** webhooks and stream ([ff603e8](https://github.com/moderation-api/sdk-ruby/commit/ff603e825cf163e821282148124e784545618518))
+
 ## 2.33.0 (2026-08-14)
 
 Full Changelog: [v2.32.0...v2.33.0](https://github.com/moderation-api/sdk-ruby/compare/v2.32.0...v2.33.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "moderation_api", "~> 2.33.0"
+gem "moderation_api", "~> 2.34.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/moderation_api/client.rb

@@ -39,6 +39,12 @@ module ModerationAPI
     # @return [ModerationAPI::Resources::Wordlist]
     attr_reader :wordlist
 
+    # @return [ModerationAPI::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [ModerationAPI::Resources::WebhookSecret]
+    attr_reader :webhook_secret
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -48,6 +54,11 @@ module ModerationAPI
       {"authorization" => "Bearer #{@secret_key}"}
     end
 
+    # @api private
+    #
+    # @return [Boolean]
+    def base_url_overridden? = @base_url_overridden
+
     # Creates and returns a new client for interacting with the API.
     #
     # @param secret_key [String, nil] Defaults to `ENV["MODAPI_SECRET_KEY"]`
@@ -70,6 +81,8 @@ module ModerationAPI
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
+      @base_url_overridden = !base_url.nil?
+
       base_url ||= "https://api.moderationapi.com/v1"
 
       if secret_key.nil?
@@ -107,6 +120,8 @@ module ModerationAPI
       @account = ModerationAPI::Resources::Account.new(client: self)
       @auth = ModerationAPI::Resources::Auth.new(client: self)
       @wordlist = ModerationAPI::Resources::Wordlist.new(client: self)
+      @webhooks = ModerationAPI::Resources::Webhooks.new(client: self)
+      @webhook_secret = ModerationAPI::Resources::WebhookSecret.new(client: self)
     end
   end
 end

data/lib/moderation_api/models/content_stream_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Content#stream
+    class ContentStreamParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute sec_web_socket_protocol
+      #
+      #   @return [Symbol, ModerationAPI::Models::ContentStreamParams::SecWebSocketProtocol]
+      required :sec_web_socket_protocol, enum: -> { ModerationAPI::ContentStreamParams::SecWebSocketProtocol }
+
+      # @!method initialize(sec_web_socket_protocol:, request_options: {})
+      #   @param sec_web_socket_protocol [Symbol, ModerationAPI::Models::ContentStreamParams::SecWebSocketProtocol]
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module SecWebSocketProtocol
+        extend ModerationAPI::Internal::Type::Enum
+
+        MODERATIONAPI_V1 = :"moderationapi.v1"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_create_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#create
+    class WebhookCreateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. One webhook URL receives all events you
+      #   list here.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookCreateParams::EventType>]
+      required :event_types,
+               -> {
+                 ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::WebhookCreateParams::EventType]
+               },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name, used to identify it in the dashboard
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute url
+      #   The webhook's URL. We'll call this URL when an event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(event_types:, name:, url:, description: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookCreateParams} for more details.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookCreateParams::EventType>] Event types this webhook subscribes to. One webhook URL receives all events you
+      #
+      #   @param name [String] The webhook's name, used to identify it in the dashboard
+      #
+      #   @param url [String] The webhook's URL. We'll call this URL when an event occurs.
+      #
+      #   @param description [String, nil] The webhook's description
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_create_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#create
+    class WebhookCreateResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The date the webhook was created.
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      #   subscribe via their single deprecated `type` instead.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookCreateResponse::EventType>]
+      required :event_types,
+               -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookCreateResponse::EventType] },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute payload_version
+      #   Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #   shape and is read-only via this API.
+      #
+      #   @return [Symbol, ModerationAPI::Models::WebhookCreateResponse::PayloadVersion]
+      required :payload_version,
+               enum: -> { ModerationAPI::Models::WebhookCreateResponse::PayloadVersion },
+               api_name: :payloadVersion
+
+      # @!attribute url
+      #   The URL we call when a subscribed event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, created_at:, event_types:, name:, payload_version:, url:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookCreateResponse} for more details.
+      #
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param created_at [String] The date the webhook was created.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookCreateResponse::EventType>] Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subs
+      #
+      #   @param name [String] The webhook's name.
+      #
+      #   @param payload_version [Symbol, ModerationAPI::Models::WebhookCreateResponse::PayloadVersion] Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #
+      #   @param url [String] The URL we call when a subscribed event occurs.
+      #
+      #   @param description [String, nil] The webhook's description.
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      #
+      # @see ModerationAPI::Models::WebhookCreateResponse#payload_version
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        V1 = :V1
+        V2 = :V2
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#delete
+    class WebhookDeleteParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the webhook to delete.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the webhook to delete.
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/webhook_delete_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#delete
+    class WebhookDeleteResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute deleted
+      #   Whether the webhook was deleted.
+      #
+      #   @return [Boolean]
+      required :deleted, ModerationAPI::Internal::Type::Boolean
+
+      # @!method initialize(id:, deleted:)
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param deleted [Boolean] Whether the webhook was deleted.
+    end
+  end
+end

data/lib/moderation_api/models/webhook_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#list
+    class WebhookListParams < 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/webhook_list_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    class WebhookListResponseItem < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The date the webhook was created.
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      #   subscribe via their single deprecated `type` instead.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookListResponseItem::EventType>]
+      required :event_types,
+               -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookListResponseItem::EventType] },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute payload_version
+      #   Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #   shape and is read-only via this API.
+      #
+      #   @return [Symbol, ModerationAPI::Models::WebhookListResponseItem::PayloadVersion]
+      required :payload_version,
+               enum: -> { ModerationAPI::Models::WebhookListResponseItem::PayloadVersion },
+               api_name: :payloadVersion
+
+      # @!attribute url
+      #   The URL we call when a subscribed event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, created_at:, event_types:, name:, payload_version:, url:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookListResponseItem} for more details.
+      #
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param created_at [String] The date the webhook was created.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookListResponseItem::EventType>] Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subs
+      #
+      #   @param name [String] The webhook's name.
+      #
+      #   @param payload_version [Symbol, ModerationAPI::Models::WebhookListResponseItem::PayloadVersion] Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #
+      #   @param url [String] The URL we call when a subscribed event occurs.
+      #
+      #   @param description [String, nil] The webhook's description.
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      #
+      # @see ModerationAPI::Models::WebhookListResponseItem#payload_version
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        V1 = :V1
+        V2 = :V2
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+
+    # @type [ModerationAPI::Internal::Type::Converter]
+    WebhookListResponse =
+      ModerationAPI::Internal::Type::ArrayOf[-> { ModerationAPI::Models::WebhookListResponseItem }]
+  end
+end

data/lib/moderation_api/models/webhook_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#retrieve
+    class WebhookRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #   The ID of the webhook to get.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String] The ID of the webhook to get.
+      #
+      #   @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moderation_api/models/webhook_retrieve_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Webhooks#retrieve
+    class WebhookRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the webhook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The date the webhook was created.
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute event_types
+      #   Event types this webhook subscribes to. Empty for legacy v1 webhooks, which
+      #   subscribe via their single deprecated `type` instead.
+      #
+      #   @return [Array<Symbol, ModerationAPI::Models::WebhookRetrieveResponse::EventType>]
+      required :event_types,
+               -> { ModerationAPI::Internal::Type::ArrayOf[enum: ModerationAPI::Models::WebhookRetrieveResponse::EventType] },
+               api_name: :eventTypes
+
+      # @!attribute name
+      #   The webhook's name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute payload_version
+      #   Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #   shape and is read-only via this API.
+      #
+      #   @return [Symbol, ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion]
+      required :payload_version,
+               enum: -> { ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion },
+               api_name: :payloadVersion
+
+      # @!attribute url
+      #   The URL we call when a subscribed event occurs.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   The webhook's description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, created_at:, event_types:, name:, payload_version:, url:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookRetrieveResponse} for more details.
+      #
+      #   @param id [String] The ID of the webhook.
+      #
+      #   @param created_at [String] The date the webhook was created.
+      #
+      #   @param event_types [Array<Symbol, ModerationAPI::Models::WebhookRetrieveResponse::EventType>] Event types this webhook subscribes to. Empty for legacy v1 webhooks, which subs
+      #
+      #   @param name [String] The webhook's name.
+      #
+      #   @param payload_version [Symbol, ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion] Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      #
+      #   @param url [String] The URL we call when a subscribed event occurs.
+      #
+      #   @param description [String, nil] The webhook's description.
+
+      module EventType
+        extend ModerationAPI::Internal::Type::Enum
+
+        QUEUE_ITEM_NEW = :QUEUE_ITEM_NEW
+        QUEUE_ITEM_COMPLETED = :QUEUE_ITEM_COMPLETED
+        QUEUE_ITEM_ACTION = :QUEUE_ITEM_ACTION
+        QUEUE_ITEM_REJECTED = :QUEUE_ITEM_REJECTED
+        QUEUE_ITEM_ALLOWED = :QUEUE_ITEM_ALLOWED
+        AUTHOR_BLOCKED = :AUTHOR_BLOCKED
+        AUTHOR_UNBLOCKED = :AUTHOR_UNBLOCKED
+        AUTHOR_SUSPENDED = :AUTHOR_SUSPENDED
+        AUTHOR_UPDATED = :AUTHOR_UPDATED
+        AUTHOR_TRUST_LEVEL_CHANGED = :AUTHOR_TRUST_LEVEL_CHANGED
+        AUTHOR_ACTION = :AUTHOR_ACTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Payload envelope version. V2 is the Stripe-style envelope; V1 is the legacy flat
+      # shape and is read-only via this API.
+      #
+      # @see ModerationAPI::Models::WebhookRetrieveResponse#payload_version
+      module PayloadVersion
+        extend ModerationAPI::Internal::Type::Enum
+
+        V1 = :V1
+        V2 = :V2
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moderation_api/models/webhook_secret_retrieve_params.rb

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::WebhookSecret#retrieve
+    class WebhookSecretRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute secret
+      #   The signing secret for this project. Every webhook delivery is signed with
+      #   HMAC-SHA256 over the raw JSON body, hex-encoded in the `modapi-signature`
+      #   header.
+      #
+      #   @return [String]
+      required :secret, String
+
+      # @!method initialize(secret:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WebhookSecretRetrieveResponse} for more details.
+      #
+      #   @param secret [String] The signing secret for this project. Every webhook delivery is signed with HMAC-
+    end
+  end
+end