moderation_api 1.2.1 → 2.0.0

data/lib/moderation_api/resources/wordlist/words.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Wordlist
+      class Words
+        # Add words to an existing wordlist
+        #
+        # @overload add(id, words:, request_options: {})
+        #
+        # @param id [String] ID of the wordlist to add words to
+        #
+        # @param words [Array<String>] Array of words to add to the wordlist. Duplicate words will be ignored.
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Wordlist::WordAddResponse]
+        #
+        # @see ModerationAPI::Models::Wordlist::WordAddParams
+        def add(id, params)
+          parsed, options = ModerationAPI::Wordlist::WordAddParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["wordlist/%1$s/words", id],
+            body: parsed,
+            model: ModerationAPI::Models::Wordlist::WordAddResponse,
+            options: options
+          )
+        end
+
+        # Remove words from an existing wordlist
+        #
+        # @overload remove(id, words:, request_options: {})
+        #
+        # @param id [String] ID of the wordlist to remove words from
+        #
+        # @param words [Array<String>] Array of words to remove from the wordlist
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Wordlist::WordRemoveResponse]
+        #
+        # @see ModerationAPI::Models::Wordlist::WordRemoveParams
+        def remove(id, params)
+          parsed, options = ModerationAPI::Wordlist::WordRemoveParams.dump_request(params)
+          @client.request(
+            method: :delete,
+            path: ["wordlist/%1$s/words", id],
+            query: parsed,
+            model: ModerationAPI::Models::Wordlist::WordRemoveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [ModerationAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/wordlist.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Wordlist
+      # @return [ModerationAPI::Resources::Wordlist::Words]
+      attr_reader :words
+
+      # Get a specific wordlist by ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] ID of the wordlist to get
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::WordlistRetrieveResponse]
+      #
+      # @see ModerationAPI::Models::WordlistRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["wordlist/%1$s", id],
+          model: ModerationAPI::Models::WordlistRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ModerationAPI::Models::WordlistUpdateParams} for more details.
+      #
+      # Update a wordlist
+      #
+      # @overload update(id, description: nil, key: nil, name: nil, strict: nil, words: nil, request_options: {})
+      #
+      # @param id [String] ID of the wordlist to update
+      #
+      # @param description [String] New description for the wordlist
+      #
+      # @param key [String] New key for the wordlist
+      #
+      # @param name [String] New name for the wordlist
+      #
+      # @param strict [Boolean] Deprecated. Now using threshold in project settings.
+      #
+      # @param words [Array<String>] New words for the wordlist. Replace the existing words with these new ones. Dupl
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::WordlistUpdateResponse]
+      #
+      # @see ModerationAPI::Models::WordlistUpdateParams
+      def update(id, params = {})
+        parsed, options = ModerationAPI::WordlistUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["wordlist/%1$s", id],
+          body: parsed,
+          model: ModerationAPI::Models::WordlistUpdateResponse,
+          options: options
+        )
+      end
+
+      # List all wordlists for the authenticated organization
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<ModerationAPI::Models::WordlistListResponseItem>]
+      #
+      # @see ModerationAPI::Models::WordlistListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "wordlist",
+          model: ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::Models::WordlistListResponseItem],
+          options: params[:request_options]
+        )
+      end
+
+      # Get the current embedding progress status for a wordlist
+      #
+      # @overload get_embedding_status(id, request_options: {})
+      #
+      # @param id [String] ID of the wordlist to check embedding status for
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::WordlistGetEmbeddingStatusResponse]
+      #
+      # @see ModerationAPI::Models::WordlistGetEmbeddingStatusParams
+      def get_embedding_status(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["wordlist/%1$s/embedding-status", id],
+          model: ModerationAPI::Models::WordlistGetEmbeddingStatusResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+        @words = ModerationAPI::Resources::Wordlist::Words.new(client: client)
+      end
+    end
+  end
+end

data/lib/moderation_api/version.rb

@@ -1,15 +1,5 @@
-=begin
-#Moderation API
-
-#API for automated content moderation
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
-
-=end
+# frozen_string_literal: true
 
 module ModerationAPI
-  VERSION = '1.2.1'
+  VERSION = "2.0.0"
 end

data/lib/moderation_api.rb

@@ -1,93 +1,119 @@
-=begin
-#Moderation API
+# frozen_string_literal: true
 
-#API for automated content moderation
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.10.0
-
-=end
-
-# Common files
-require 'moderation_api/api_client'
-require 'moderation_api/api_error'
-require 'moderation_api/version'
-require 'moderation_api/configuration'
-
-# Models
-ModerationAPI.autoload :AccountGet200Response, 'moderation_api/models/account_get200_response'
-ModerationAPI.autoload :AccountGet200ResponseCurrentProject, 'moderation_api/models/account_get200_response_current_project'
-ModerationAPI.autoload :ActionsCreateRequest, 'moderation_api/models/actions_create_request'
-ModerationAPI.autoload :ActionsCreateRequestWebhooksInner, 'moderation_api/models/actions_create_request_webhooks_inner'
-ModerationAPI.autoload :ActionsDelete200Response, 'moderation_api/models/actions_delete200_response'
-ModerationAPI.autoload :ActionsExecute200Response, 'moderation_api/models/actions_execute200_response'
-ModerationAPI.autoload :ActionsExecuteDeprecatedRequest, 'moderation_api/models/actions_execute_deprecated_request'
-ModerationAPI.autoload :ActionsExecuteRequest, 'moderation_api/models/actions_execute_request'
-ModerationAPI.autoload :ActionsGet200Response, 'moderation_api/models/actions_get200_response'
-ModerationAPI.autoload :ActionsGet200ResponseWebhooksInner, 'moderation_api/models/actions_get200_response_webhooks_inner'
-ModerationAPI.autoload :ActionsList200ResponseInner, 'moderation_api/models/actions_list200_response_inner'
-ModerationAPI.autoload :ActionsList200ResponseInnerPossibleValuesInner, 'moderation_api/models/actions_list200_response_inner_possible_values_inner'
-ModerationAPI.autoload :ActionsList400Response, 'moderation_api/models/actions_list400_response'
-ModerationAPI.autoload :ActionsList400ResponseIssuesInner, 'moderation_api/models/actions_list400_response_issues_inner'
-ModerationAPI.autoload :ActionsUpdateRequest, 'moderation_api/models/actions_update_request'
-ModerationAPI.autoload :ModerationAudioRequest, 'moderation_api/models/moderation_audio_request'
-ModerationAPI.autoload :ModerationImage200Response, 'moderation_api/models/moderation_image200_response'
-ModerationAPI.autoload :ModerationImage200ResponseLabelsInner, 'moderation_api/models/moderation_image200_response_labels_inner'
-ModerationAPI.autoload :ModerationImageRequest, 'moderation_api/models/moderation_image_request'
-ModerationAPI.autoload :ModerationObject200Response, 'moderation_api/models/moderation_object200_response'
-ModerationAPI.autoload :ModerationObject200ResponseAllOfEntitiesInner, 'moderation_api/models/moderation_object200_response_all_of_entities_inner'
-ModerationAPI.autoload :ModerationObject200ResponseAllOfFieldsInner, 'moderation_api/models/moderation_object200_response_all_of_fields_inner'
-ModerationAPI.autoload :ModerationObject200ResponseAllOfLabelsInner, 'moderation_api/models/moderation_object200_response_all_of_labels_inner'
-ModerationAPI.autoload :ModerationObjectRequest, 'moderation_api/models/moderation_object_request'
-ModerationAPI.autoload :ModerationObjectRequestValue, 'moderation_api/models/moderation_object_request_value'
-ModerationAPI.autoload :ModerationObjectRequestValueDataValue, 'moderation_api/models/moderation_object_request_value_data_value'
-ModerationAPI.autoload :ModerationText200Response, 'moderation_api/models/moderation_text200_response'
-ModerationAPI.autoload :ModerationText200ResponseAllOfAddress, 'moderation_api/models/moderation_text200_response_all_of_address'
-ModerationAPI.autoload :ModerationText200ResponseAllOfEmail, 'moderation_api/models/moderation_text200_response_all_of_email'
-ModerationAPI.autoload :ModerationText200ResponseAllOfName, 'moderation_api/models/moderation_text200_response_all_of_name'
-ModerationAPI.autoload :ModerationText200ResponseAllOfNsfw, 'moderation_api/models/moderation_text200_response_all_of_nsfw'
-ModerationAPI.autoload :ModerationText200ResponseAllOfNsfwLabelScores, 'moderation_api/models/moderation_text200_response_all_of_nsfw_label_scores'
-ModerationAPI.autoload :ModerationText200ResponseAllOfPhone, 'moderation_api/models/moderation_text200_response_all_of_phone'
-ModerationAPI.autoload :ModerationText200ResponseAllOfProfanity, 'moderation_api/models/moderation_text200_response_all_of_profanity'
-ModerationAPI.autoload :ModerationText200ResponseAllOfPropriety, 'moderation_api/models/moderation_text200_response_all_of_propriety'
-ModerationAPI.autoload :ModerationText200ResponseAllOfProprietyLabelScores, 'moderation_api/models/moderation_text200_response_all_of_propriety_label_scores'
-ModerationAPI.autoload :ModerationText200ResponseAllOfQuality, 'moderation_api/models/moderation_text200_response_all_of_quality'
-ModerationAPI.autoload :ModerationText200ResponseAllOfQualityLabelScores, 'moderation_api/models/moderation_text200_response_all_of_quality_label_scores'
-ModerationAPI.autoload :ModerationText200ResponseAllOfRequest, 'moderation_api/models/moderation_text200_response_all_of_request'
-ModerationAPI.autoload :ModerationText200ResponseAllOfSensitive, 'moderation_api/models/moderation_text200_response_all_of_sensitive'
-ModerationAPI.autoload :ModerationText200ResponseAllOfSentiment, 'moderation_api/models/moderation_text200_response_all_of_sentiment'
-ModerationAPI.autoload :ModerationText200ResponseAllOfSentimentLabelScores, 'moderation_api/models/moderation_text200_response_all_of_sentiment_label_scores'
-ModerationAPI.autoload :ModerationText200ResponseAllOfToxicity, 'moderation_api/models/moderation_text200_response_all_of_toxicity'
-ModerationAPI.autoload :ModerationText200ResponseAllOfToxicityLabelScores, 'moderation_api/models/moderation_text200_response_all_of_toxicity_label_scores'
-ModerationAPI.autoload :ModerationText200ResponseAllOfUrl, 'moderation_api/models/moderation_text200_response_all_of_url'
-ModerationAPI.autoload :ModerationText200ResponseAllOfUsername, 'moderation_api/models/moderation_text200_response_all_of_username'
-ModerationAPI.autoload :ModerationText200ResponseAllOfWordlist, 'moderation_api/models/moderation_text200_response_all_of_wordlist'
-ModerationAPI.autoload :ModerationText200ResponseAllOfWordlistsInner, 'moderation_api/models/moderation_text200_response_all_of_wordlists_inner'
-ModerationAPI.autoload :ModerationTextRequest, 'moderation_api/models/moderation_text_request'
-ModerationAPI.autoload :ModerationVideo200Response, 'moderation_api/models/moderation_video200_response'
-ModerationAPI.autoload :ModerationVideoRequest, 'moderation_api/models/moderation_video_request'
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
 
-# APIs
-ModerationAPI.autoload :AccountApi, 'moderation_api/api/account_api'
-ModerationAPI.autoload :ModerateApi, 'moderation_api/api/moderate_api'
-ModerationAPI.autoload :QueueActionsApi, 'moderation_api/api/queue_actions_api'
+# Gems.
+require "connection_pool"
 
-module ModerationAPI
-  class << self
-    # Customize default settings for the SDK using block.
-    #   ModerationAPI.configure do |config|
-    #     config.username = "xxx"
-    #     config.password = "xxx"
-    #   end
-    # If no block given, return the default Configuration object.
-    def configure
-      if block_given?
-        yield(Configuration.default)
-      else
-        Configuration.default
-      end
-    end
-  end
-end
+# Package files.
+require_relative "moderation_api/version"
+require_relative "moderation_api/internal/util"
+require_relative "moderation_api/internal/type/converter"
+require_relative "moderation_api/internal/type/unknown"
+require_relative "moderation_api/internal/type/boolean"
+require_relative "moderation_api/internal/type/file_input"
+require_relative "moderation_api/internal/type/enum"
+require_relative "moderation_api/internal/type/union"
+require_relative "moderation_api/internal/type/array_of"
+require_relative "moderation_api/internal/type/hash_of"
+require_relative "moderation_api/internal/type/base_model"
+require_relative "moderation_api/internal/type/base_page"
+require_relative "moderation_api/internal/type/request_parameters"
+require_relative "moderation_api/internal"
+require_relative "moderation_api/request_options"
+require_relative "moderation_api/file_part"
+require_relative "moderation_api/errors"
+require_relative "moderation_api/internal/transport/base_client"
+require_relative "moderation_api/internal/transport/pooled_net_requester"
+require_relative "moderation_api/client"
+require_relative "moderation_api/models/account_list_params"
+require_relative "moderation_api/models/account_list_response"
+require_relative "moderation_api/models/action_create_params"
+require_relative "moderation_api/models/action_create_response"
+require_relative "moderation_api/models/action_delete_params"
+require_relative "moderation_api/models/action_delete_response"
+require_relative "moderation_api/models/action_list_params"
+require_relative "moderation_api/models/action_list_response"
+require_relative "moderation_api/models/action_retrieve_params"
+require_relative "moderation_api/models/action_retrieve_response"
+require_relative "moderation_api/models/actions/execute_execute_by_id_params"
+require_relative "moderation_api/models/actions/execute_execute_by_id_response"
+require_relative "moderation_api/models/actions/execute_execute_params"
+require_relative "moderation_api/models/actions/execute_execute_response"
+require_relative "moderation_api/models/action_update_params"
+require_relative "moderation_api/models/action_update_response"
+require_relative "moderation_api/models/auth_create_params"
+require_relative "moderation_api/models/auth_create_response"
+require_relative "moderation_api/models/author_create_params"
+require_relative "moderation_api/models/author_create_response"
+require_relative "moderation_api/models/author_delete_params"
+require_relative "moderation_api/models/author_delete_response"
+require_relative "moderation_api/models/author_list_params"
+require_relative "moderation_api/models/author_list_response"
+require_relative "moderation_api/models/author_retrieve_params"
+require_relative "moderation_api/models/author_retrieve_response"
+require_relative "moderation_api/models/author_update_params"
+require_relative "moderation_api/models/author_update_response"
+require_relative "moderation_api/models/auth_retrieve_params"
+require_relative "moderation_api/models/auth_retrieve_response"
+require_relative "moderation_api/models/content_submit_params"
+require_relative "moderation_api/models/content_submit_response"
+require_relative "moderation_api/models/queue/item_list_params"
+require_relative "moderation_api/models/queue/item_list_response"
+require_relative "moderation_api/models/queue/item_resolve_params"
+require_relative "moderation_api/models/queue/item_resolve_response"
+require_relative "moderation_api/models/queue/item_unresolve_params"
+require_relative "moderation_api/models/queue/item_unresolve_response"
+require_relative "moderation_api/models/queue_get_stats_params"
+require_relative "moderation_api/models/queue_get_stats_response"
+require_relative "moderation_api/models/queue_retrieve_params"
+require_relative "moderation_api/models/queue_retrieve_response"
+require_relative "moderation_api/models/wordlist/word_add_params"
+require_relative "moderation_api/models/wordlist/word_add_response"
+require_relative "moderation_api/models/wordlist/word_remove_params"
+require_relative "moderation_api/models/wordlist/word_remove_response"
+require_relative "moderation_api/models/wordlist_get_embedding_status_params"
+require_relative "moderation_api/models/wordlist_get_embedding_status_response"
+require_relative "moderation_api/models/wordlist_list_params"
+require_relative "moderation_api/models/wordlist_list_response"
+require_relative "moderation_api/models/wordlist_retrieve_params"
+require_relative "moderation_api/models/wordlist_retrieve_response"
+require_relative "moderation_api/models/wordlist_update_params"
+require_relative "moderation_api/models/wordlist_update_response"
+require_relative "moderation_api/models"
+require_relative "moderation_api/resources/account"
+require_relative "moderation_api/resources/actions"
+require_relative "moderation_api/resources/actions/execute"
+require_relative "moderation_api/resources/auth"
+require_relative "moderation_api/resources/authors"
+require_relative "moderation_api/resources/content"
+require_relative "moderation_api/resources/queue"
+require_relative "moderation_api/resources/queue/items"
+require_relative "moderation_api/resources/wordlist"
+require_relative "moderation_api/resources/wordlist/words"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/moderation_api/client.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module ModerationAPI
+  class Client < ModerationAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :secret_key
+
+    sig { returns(ModerationAPI::Resources::Authors) }
+    attr_reader :authors
+
+    sig { returns(ModerationAPI::Resources::Queue) }
+    attr_reader :queue
+
+    sig { returns(ModerationAPI::Resources::Actions) }
+    attr_reader :actions
+
+    sig { returns(ModerationAPI::Resources::Content) }
+    attr_reader :content
+
+    sig { returns(ModerationAPI::Resources::Account) }
+    attr_reader :account
+
+    sig { returns(ModerationAPI::Resources::Auth) }
+    attr_reader :auth
+
+    sig { returns(ModerationAPI::Resources::Wordlist) }
+    attr_reader :wordlist
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        secret_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["MODAPI_SECRET_KEY"]`
+      secret_key: ENV["MODAPI_SECRET_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERATION_API_BASE_URL"]`
+      base_url: ENV["MODERATION_API_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: ModerationAPI::Client::DEFAULT_MAX_RETRIES,
+      timeout: ModerationAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: ModerationAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: ModerationAPI::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end