moderation_api 2.33.0 → 2.35.0

data/rbi/moderation_api/models/webhook_retrieve_response.rbi

@@ -0,0 +1,225 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::Models::WebhookRetrieveResponse,
+            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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::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::WebhookRetrieveResponse::EventType::OrSymbol
+            ],
+          name: String,
+          payload_version:
+            ModerationAPI::Models::WebhookRetrieveResponse::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::WebhookRetrieveResponse::EventType::TaggedSymbol
+              ],
+            name: String,
+            payload_version:
+              ModerationAPI::Models::WebhookRetrieveResponse::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::WebhookRetrieveResponse::EventType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUE_ITEM_NEW =
+          T.let(
+            :QUEUE_ITEM_NEW,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_COMPLETED =
+          T.let(
+            :QUEUE_ITEM_COMPLETED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ACTION =
+          T.let(
+            :QUEUE_ITEM_ACTION,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_REJECTED =
+          T.let(
+            :QUEUE_ITEM_REJECTED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        QUEUE_ITEM_ALLOWED =
+          T.let(
+            :QUEUE_ITEM_ALLOWED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_BLOCKED =
+          T.let(
+            :AUTHOR_BLOCKED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_UNBLOCKED =
+          T.let(
+            :AUTHOR_UNBLOCKED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_SUSPENDED =
+          T.let(
+            :AUTHOR_SUSPENDED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_UPDATED =
+          T.let(
+            :AUTHOR_UPDATED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_TRUST_LEVEL_CHANGED =
+          T.let(
+            :AUTHOR_TRUST_LEVEL_CHANGED,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+        AUTHOR_ACTION =
+          T.let(
+            :AUTHOR_ACTION,
+            ModerationAPI::Models::WebhookRetrieveResponse::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::WebhookRetrieveResponse::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::WebhookRetrieveResponse::PayloadVersion
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        V1 =
+          T.let(
+            :V1,
+            ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion::TaggedSymbol
+          )
+        V2 =
+          T.let(
+            :V2,
+            ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModerationAPI::Models::WebhookRetrieveResponse::PayloadVersion::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moderation_api/models/webhook_secret_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookSecretRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::WebhookSecretRetrieveParams,
+            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/webhook_secret_retrieve_response.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module ModerationAPI
+  module Models
+    class WebhookSecretRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModerationAPI::Models::WebhookSecretRetrieveResponse,
+            ModerationAPI::Internal::AnyHash
+          )
+        end
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :secret
+
+      sig { params(secret: String).returns(T.attached_class) }
+      def self.new(
+        # 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.
+        secret:
+      )
+      end
+
+      sig { override.returns({ secret: String }) }
+      def to_hash
+      end
+    end
+  end
+end

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