moderation_api 1.2.2 → 2.0.0

data/sig/moderation_api/models/queue_retrieve_response.rbs

@@ -0,0 +1,207 @@
+module ModerationAPI
+  module Models
+    type queue_retrieve_response =
+      { queue: ModerationAPI::Models::QueueRetrieveResponse::Queue }
+
+    class QueueRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor queue: ModerationAPI::Models::QueueRetrieveResponse::Queue
+
+      def initialize: (
+        queue: ModerationAPI::Models::QueueRetrieveResponse::Queue
+      ) -> void
+
+      def to_hash: -> {
+        queue: ModerationAPI::Models::QueueRetrieveResponse::Queue
+      }
+
+      type queue =
+        {
+          id: String,
+          description: String,
+          filter: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter,
+          name: String,
+          resolved_items_count: Float,
+          total_items_count: Float,
+          unresolved_items_count: Float
+        }
+
+      class Queue < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor description: String
+
+        attr_accessor filter: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter
+
+        attr_accessor name: String
+
+        attr_accessor resolved_items_count: Float
+
+        attr_accessor total_items_count: Float
+
+        attr_accessor unresolved_items_count: Float
+
+        def initialize: (
+          id: String,
+          description: String,
+          filter: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter,
+          name: String,
+          resolved_items_count: Float,
+          total_items_count: Float,
+          unresolved_items_count: Float
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          description: String,
+          filter: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter,
+          name: String,
+          resolved_items_count: Float,
+          total_items_count: Float,
+          unresolved_items_count: Float
+        }
+
+        type filter =
+          {
+            after_date: String,
+            author_id: String,
+            before_date: String,
+            conversation_ids: ::Array[String?],
+            filtered_action_ids: ::Array[String],
+            filtered_channel_ids: ::Array[String],
+            filter_labels: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel],
+            labels: ::Array[String],
+            recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
+            show_checked: bool
+          }
+
+        class Filter < ModerationAPI::Internal::Type::BaseModel
+          attr_reader after_date: String?
+
+          def after_date=: (String) -> String
+
+          attr_reader author_id: String?
+
+          def author_id=: (String) -> String
+
+          attr_reader before_date: String?
+
+          def before_date=: (String) -> String
+
+          attr_reader conversation_ids: ::Array[String?]?
+
+          def conversation_ids=: (::Array[String?]) -> ::Array[String?]
+
+          attr_reader filtered_action_ids: ::Array[String]?
+
+          def filtered_action_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader filtered_channel_ids: ::Array[String]?
+
+          def filtered_channel_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader filter_labels: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel]?
+
+          def filter_labels=: (
+            ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel]
+          ) -> ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel]
+
+          attr_reader labels: ::Array[String]?
+
+          def labels=: (::Array[String]) -> ::Array[String]
+
+          attr_reader recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action]?
+
+          def recommendation_actions=: (
+            ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action]
+          ) -> ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action]
+
+          attr_reader show_checked: bool?
+
+          def show_checked=: (bool) -> bool
+
+          def initialize: (
+            ?after_date: String,
+            ?author_id: String,
+            ?before_date: String,
+            ?conversation_ids: ::Array[String?],
+            ?filtered_action_ids: ::Array[String],
+            ?filtered_channel_ids: ::Array[String],
+            ?filter_labels: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel],
+            ?labels: ::Array[String],
+            ?recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
+            ?show_checked: bool
+          ) -> void
+
+          def to_hash: -> {
+            after_date: String,
+            author_id: String,
+            before_date: String,
+            conversation_ids: ::Array[String?],
+            filtered_action_ids: ::Array[String],
+            filtered_channel_ids: ::Array[String],
+            filter_labels: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel],
+            labels: ::Array[String],
+            recommendation_actions: ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action],
+            show_checked: bool
+          }
+
+          type filter_label =
+            {
+              label: String,
+              type: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::type_,
+              max_threshold: Float?,
+              min_threshold: Float?
+            }
+
+          class FilterLabel < ModerationAPI::Internal::Type::BaseModel
+            attr_accessor label: String
+
+            attr_accessor type: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::type_
+
+            attr_accessor max_threshold: Float?
+
+            attr_accessor min_threshold: Float?
+
+            def initialize: (
+              label: String,
+              type: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::type_,
+              ?max_threshold: Float?,
+              ?min_threshold: Float?
+            ) -> void
+
+            def to_hash: -> {
+              label: String,
+              type: ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::type_,
+              max_threshold: Float?,
+              min_threshold: Float?
+            }
+
+            type type_ = :FLAGGED | :NOT_FLAGGED | :THRESHOLDS
+
+            module Type
+              extend ModerationAPI::Internal::Type::Enum
+
+              FLAGGED: :FLAGGED
+              NOT_FLAGGED: :NOT_FLAGGED
+              THRESHOLDS: :THRESHOLDS
+
+              def self?.values: -> ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::FilterLabel::type_]
+            end
+          end
+
+          type recommendation_action = :review | :allow | :reject
+
+          module RecommendationAction
+            extend ModerationAPI::Internal::Type::Enum
+
+            REVIEW: :review
+            ALLOW: :allow
+            REJECT: :reject
+
+            def self?.values: -> ::Array[ModerationAPI::Models::QueueRetrieveResponse::Queue::Filter::recommendation_action]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/moderation_api/models/wordlist/word_add_params.rbs

@@ -0,0 +1,26 @@
+module ModerationAPI
+  module Models
+    module Wordlist
+      type word_add_params =
+        { words: ::Array[String] }
+        & ModerationAPI::Internal::Type::request_parameters
+
+      class WordAddParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        attr_accessor words: ::Array[String]
+
+        def initialize: (
+          words: ::Array[String],
+          ?request_options: ModerationAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          words: ::Array[String],
+          request_options: ModerationAPI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/wordlist/word_add_response.rbs

@@ -0,0 +1,28 @@
+module ModerationAPI
+  module Models
+    module Wordlist
+      type word_add_response =
+        { added_count: Float, added_words: ::Array[String], total_count: Float }
+
+      class WordAddResponse < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor added_count: Float
+
+        attr_accessor added_words: ::Array[String]
+
+        attr_accessor total_count: Float
+
+        def initialize: (
+          added_count: Float,
+          added_words: ::Array[String],
+          total_count: Float
+        ) -> void
+
+        def to_hash: -> {
+          added_count: Float,
+          added_words: ::Array[String],
+          total_count: Float
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/wordlist/word_remove_params.rbs

@@ -0,0 +1,26 @@
+module ModerationAPI
+  module Models
+    module Wordlist
+      type word_remove_params =
+        { words: ::Array[String] }
+        & ModerationAPI::Internal::Type::request_parameters
+
+      class WordRemoveParams < ModerationAPI::Internal::Type::BaseModel
+        extend ModerationAPI::Internal::Type::RequestParameters::Converter
+        include ModerationAPI::Internal::Type::RequestParameters
+
+        attr_accessor words: ::Array[String]
+
+        def initialize: (
+          words: ::Array[String],
+          ?request_options: ModerationAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          words: ::Array[String],
+          request_options: ModerationAPI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/wordlist/word_remove_response.rbs

@@ -0,0 +1,32 @@
+module ModerationAPI
+  module Models
+    module Wordlist
+      type word_remove_response =
+        {
+          removed_count: Float,
+          removed_words: ::Array[String],
+          total_count: Float
+        }
+
+      class WordRemoveResponse < ModerationAPI::Internal::Type::BaseModel
+        attr_accessor removed_count: Float
+
+        attr_accessor removed_words: ::Array[String]
+
+        attr_accessor total_count: Float
+
+        def initialize: (
+          removed_count: Float,
+          removed_words: ::Array[String],
+          total_count: Float
+        ) -> void
+
+        def to_hash: -> {
+          removed_count: Float,
+          removed_words: ::Array[String],
+          total_count: Float
+        }
+      end
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_get_embedding_status_params.rbs

@@ -0,0 +1,15 @@
+module ModerationAPI
+  module Models
+    type wordlist_get_embedding_status_params =
+      {  } & ModerationAPI::Internal::Type::request_parameters
+
+    class WordlistGetEmbeddingStatusParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: ModerationAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: ModerationAPI::RequestOptions }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_get_embedding_status_response.rbs

@@ -0,0 +1,26 @@
+module ModerationAPI
+  module Models
+    type wordlist_get_embedding_status_response =
+      { progress: Float, remaining_words: Float, total_words: Float }
+
+    class WordlistGetEmbeddingStatusResponse < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor progress: Float
+
+      attr_accessor remaining_words: Float
+
+      attr_accessor total_words: Float
+
+      def initialize: (
+        progress: Float,
+        remaining_words: Float,
+        total_words: Float
+      ) -> void
+
+      def to_hash: -> {
+        progress: Float,
+        remaining_words: Float,
+        total_words: Float
+      }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_list_params.rbs

@@ -0,0 +1,15 @@
+module ModerationAPI
+  module Models
+    type wordlist_list_params =
+      {  } & ModerationAPI::Internal::Type::request_parameters
+
+    class WordlistListParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: ModerationAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: ModerationAPI::RequestOptions }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_list_response.rbs

@@ -0,0 +1,45 @@
+module ModerationAPI
+  module Models
+    type wordlist_list_response_item =
+      {
+        id: String,
+        created_at: String?,
+        description: String?,
+        name: String?,
+        user_id: String?
+      }
+
+    class WordlistListResponseItem < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: String?
+
+      attr_accessor description: String?
+
+      attr_accessor name: String?
+
+      attr_accessor user_id: String?
+
+      def initialize: (
+        id: String,
+        created_at: String?,
+        description: String?,
+        name: String?,
+        user_id: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: String?,
+        description: String?,
+        name: String?,
+        user_id: String?
+      }
+    end
+
+    type wordlist_list_response =
+      ::Array[ModerationAPI::Models::WordlistListResponseItem]
+
+    WordlistListResponse: ModerationAPI::Internal::Type::Converter
+  end
+end

data/sig/moderation_api/models/wordlist_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module ModerationAPI
+  module Models
+    type wordlist_retrieve_params =
+      {  } & ModerationAPI::Internal::Type::request_parameters
+
+    class WordlistRetrieveParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: ModerationAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: ModerationAPI::RequestOptions }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_retrieve_response.rbs

@@ -0,0 +1,50 @@
+module ModerationAPI
+  module Models
+    type wordlist_retrieve_response =
+      {
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      }
+
+    class WordlistRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: String
+
+      attr_accessor name: String?
+
+      attr_accessor organization_id: String
+
+      attr_accessor strict: bool
+
+      attr_accessor user_id: String?
+
+      attr_accessor words: ::Array[String]
+
+      def initialize: (
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_update_params.rbs

@@ -0,0 +1,56 @@
+module ModerationAPI
+  module Models
+    type wordlist_update_params =
+      {
+        description: String,
+        key: String,
+        name: String,
+        strict: bool,
+        words: ::Array[String]
+      }
+      & ModerationAPI::Internal::Type::request_parameters
+
+    class WordlistUpdateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader key: String?
+
+      def key=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader strict: bool?
+
+      def strict=: (bool) -> bool
+
+      attr_reader words: ::Array[String]?
+
+      def words=: (::Array[String]) -> ::Array[String]
+
+      def initialize: (
+        ?description: String,
+        ?key: String,
+        ?name: String,
+        ?strict: bool,
+        ?words: ::Array[String],
+        ?request_options: ModerationAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        description: String,
+        key: String,
+        name: String,
+        strict: bool,
+        words: ::Array[String],
+        request_options: ModerationAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/moderation_api/models/wordlist_update_response.rbs

@@ -0,0 +1,50 @@
+module ModerationAPI
+  module Models
+    type wordlist_update_response =
+      {
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      }
+
+    class WordlistUpdateResponse < ModerationAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: String
+
+      attr_accessor name: String?
+
+      attr_accessor organization_id: String
+
+      attr_accessor strict: bool
+
+      attr_accessor user_id: String?
+
+      attr_accessor words: ::Array[String]
+
+      def initialize: (
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: String,
+        name: String?,
+        organization_id: String,
+        strict: bool,
+        user_id: String?,
+        words: ::Array[String]
+      }
+    end
+  end
+end

data/sig/moderation_api/models.rbs

@@ -0,0 +1,47 @@
+module ModerationAPI
+  class AccountListParams = ModerationAPI::Models::AccountListParams
+
+  class ActionCreateParams = ModerationAPI::Models::ActionCreateParams
+
+  class ActionDeleteParams = ModerationAPI::Models::ActionDeleteParams
+
+  class ActionListParams = ModerationAPI::Models::ActionListParams
+
+  class ActionRetrieveParams = ModerationAPI::Models::ActionRetrieveParams
+
+  module Actions = ModerationAPI::Models::Actions
+
+  class ActionUpdateParams = ModerationAPI::Models::ActionUpdateParams
+
+  class AuthCreateParams = ModerationAPI::Models::AuthCreateParams
+
+  class AuthorCreateParams = ModerationAPI::Models::AuthorCreateParams
+
+  class AuthorDeleteParams = ModerationAPI::Models::AuthorDeleteParams
+
+  class AuthorListParams = ModerationAPI::Models::AuthorListParams
+
+  class AuthorRetrieveParams = ModerationAPI::Models::AuthorRetrieveParams
+
+  class AuthorUpdateParams = ModerationAPI::Models::AuthorUpdateParams
+
+  class AuthRetrieveParams = ModerationAPI::Models::AuthRetrieveParams
+
+  class ContentSubmitParams = ModerationAPI::Models::ContentSubmitParams
+
+  module Queue = ModerationAPI::Models::Queue
+
+  class QueueGetStatsParams = ModerationAPI::Models::QueueGetStatsParams
+
+  class QueueRetrieveParams = ModerationAPI::Models::QueueRetrieveParams
+
+  module Wordlist = ModerationAPI::Models::Wordlist
+
+  class WordlistGetEmbeddingStatusParams = ModerationAPI::Models::WordlistGetEmbeddingStatusParams
+
+  class WordlistListParams = ModerationAPI::Models::WordlistListParams
+
+  class WordlistRetrieveParams = ModerationAPI::Models::WordlistRetrieveParams
+
+  class WordlistUpdateParams = ModerationAPI::Models::WordlistUpdateParams
+end

data/sig/moderation_api/request_options.rbs

@@ -0,0 +1,36 @@
+module ModerationAPI
+  type request_opts =
+    ModerationAPI::RequestOptions
+    | ModerationAPI::request_options
+    | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < ModerationAPI::Internal::Type::BaseModel
+    def self.validate!: (ModerationAPI::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?ModerationAPI::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end