moderation_api 1.2.2 → 2.0.1

data/lib/moderation_api/models/wordlist_list_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    class WordlistListResponseItem < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier of the wordlist
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the wordlist was created
+      #
+      #   @return [String, nil]
+      required :created_at, String, api_name: :createdAt, nil?: true
+
+      # @!attribute description
+      #   Description of the wordlist
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute name
+      #   Name of the wordlist
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute user_id
+      #   User who created the wordlist
+      #
+      #   @return [String, nil]
+      required :user_id, String, api_name: :userId, nil?: true
+
+      # @!method initialize(id:, created_at:, description:, name:, user_id:)
+      #   @param id [String] Unique identifier of the wordlist
+      #
+      #   @param created_at [String, nil] When the wordlist was created
+      #
+      #   @param description [String, nil] Description of the wordlist
+      #
+      #   @param name [String, nil] Name of the wordlist
+      #
+      #   @param user_id [String, nil] User who created the wordlist
+    end
+
+    # @type [ModerationAPI::Internal::Type::Converter]
+    WordlistListResponse =
+      ModerationAPI::Internal::Type::ArrayOf[-> { ModerationAPI::Models::WordlistListResponseItem }]
+  end
+end

data/lib/moderation_api/models/wordlist_retrieve_params.rb

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#retrieve
+    class WordlistRetrieveResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   ID of the wordlist
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Creation date of the wordlist
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute name
+      #   Name of the wordlist
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute organization_id
+      #   ID of the organization
+      #
+      #   @return [String]
+      required :organization_id, String, api_name: :organizationId
+
+      # @!attribute strict
+      #   Strict mode
+      #
+      #   @return [Boolean]
+      required :strict, ModerationAPI::Internal::Type::Boolean
+
+      # @!attribute user_id
+      #   ID of the user
+      #
+      #   @return [String, nil]
+      required :user_id, String, api_name: :userId, nil?: true
+
+      # @!attribute words
+      #   Words in the wordlist
+      #
+      #   @return [Array<String>]
+      required :words, ModerationAPI::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, created_at:, name:, organization_id:, strict:, user_id:, words:)
+      #   @param id [String] ID of the wordlist
+      #
+      #   @param created_at [String] Creation date of the wordlist
+      #
+      #   @param name [String, nil] Name of the wordlist
+      #
+      #   @param organization_id [String] ID of the organization
+      #
+      #   @param strict [Boolean] Strict mode
+      #
+      #   @param user_id [String, nil] ID of the user
+      #
+      #   @param words [Array<String>] Words in the wordlist
+    end
+  end
+end

data/lib/moderation_api/models/wordlist_update_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#update
+    class WordlistUpdateParams < ModerationAPI::Internal::Type::BaseModel
+      extend ModerationAPI::Internal::Type::RequestParameters::Converter
+      include ModerationAPI::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   New description for the wordlist
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute key
+      #   New key for the wordlist
+      #
+      #   @return [String, nil]
+      optional :key, String
+
+      # @!attribute name
+      #   New name for the wordlist
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute strict
+      #   Deprecated. Now using threshold in project settings.
+      #
+      #   @return [Boolean, nil]
+      optional :strict, ModerationAPI::Internal::Type::Boolean
+
+      # @!attribute words
+      #   New words for the wordlist. Replace the existing words with these new ones.
+      #   Duplicate words will be ignored.
+      #
+      #   @return [Array<String>, nil]
+      optional :words, ModerationAPI::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(description: nil, key: nil, name: nil, strict: nil, words: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModerationAPI::Models::WordlistUpdateParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/moderation_api/models/wordlist_update_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Models
+    # @see ModerationAPI::Resources::Wordlist#update
+    class WordlistUpdateResponse < ModerationAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   ID of the wordlist
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Creation date of the wordlist
+      #
+      #   @return [String]
+      required :created_at, String, api_name: :createdAt
+
+      # @!attribute name
+      #   Name of the wordlist
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute organization_id
+      #   ID of the organization
+      #
+      #   @return [String]
+      required :organization_id, String, api_name: :organizationId
+
+      # @!attribute strict
+      #   Strict mode
+      #
+      #   @return [Boolean]
+      required :strict, ModerationAPI::Internal::Type::Boolean
+
+      # @!attribute user_id
+      #   ID of the user
+      #
+      #   @return [String, nil]
+      required :user_id, String, api_name: :userId, nil?: true
+
+      # @!attribute words
+      #   Words in the wordlist
+      #
+      #   @return [Array<String>]
+      required :words, ModerationAPI::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, created_at:, name:, organization_id:, strict:, user_id:, words:)
+      #   @param id [String] ID of the wordlist
+      #
+      #   @param created_at [String] Creation date of the wordlist
+      #
+      #   @param name [String, nil] Name of the wordlist
+      #
+      #   @param organization_id [String] ID of the organization
+      #
+      #   @param strict [Boolean] Strict mode
+      #
+      #   @param user_id [String, nil] ID of the user
+      #
+      #   @param words [Array<String>] Words in the wordlist
+    end
+  end
+end

data/lib/moderation_api/models.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  [
+    ModerationAPI::Internal::Type::BaseModel,
+    *ModerationAPI::Internal::Type::BaseModel.subclasses
+  ].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, ModerationAPI::Internal::AnyHash) } }
+  end
+
+  ModerationAPI::Internal::Util.walk_namespaces(ModerationAPI::Models).each do |mod|
+    case mod
+    in ModerationAPI::Internal::Type::Enum | ModerationAPI::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  ModerationAPI::Internal::Util.walk_namespaces(ModerationAPI::Models)
+                               .lazy
+                               .grep(ModerationAPI::Internal::Type::Union)
+                               .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  AccountListParams = ModerationAPI::Models::AccountListParams
+
+  ActionCreateParams = ModerationAPI::Models::ActionCreateParams
+
+  ActionDeleteParams = ModerationAPI::Models::ActionDeleteParams
+
+  ActionListParams = ModerationAPI::Models::ActionListParams
+
+  ActionRetrieveParams = ModerationAPI::Models::ActionRetrieveParams
+
+  Actions = ModerationAPI::Models::Actions
+
+  ActionUpdateParams = ModerationAPI::Models::ActionUpdateParams
+
+  AuthCreateParams = ModerationAPI::Models::AuthCreateParams
+
+  AuthorCreateParams = ModerationAPI::Models::AuthorCreateParams
+
+  AuthorDeleteParams = ModerationAPI::Models::AuthorDeleteParams
+
+  AuthorListParams = ModerationAPI::Models::AuthorListParams
+
+  AuthorRetrieveParams = ModerationAPI::Models::AuthorRetrieveParams
+
+  AuthorUpdateParams = ModerationAPI::Models::AuthorUpdateParams
+
+  AuthRetrieveParams = ModerationAPI::Models::AuthRetrieveParams
+
+  ContentSubmitParams = ModerationAPI::Models::ContentSubmitParams
+
+  Queue = ModerationAPI::Models::Queue
+
+  QueueGetStatsParams = ModerationAPI::Models::QueueGetStatsParams
+
+  QueueRetrieveParams = ModerationAPI::Models::QueueRetrieveParams
+
+  Wordlist = ModerationAPI::Models::Wordlist
+
+  WordlistGetEmbeddingStatusParams = ModerationAPI::Models::WordlistGetEmbeddingStatusParams
+
+  WordlistListParams = ModerationAPI::Models::WordlistListParams
+
+  WordlistRetrieveParams = ModerationAPI::Models::WordlistRetrieveParams
+
+  WordlistUpdateParams = ModerationAPI::Models::WordlistUpdateParams
+end

data/lib/moderation_api/request_options.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ModerationAPI::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [ModerationAPI::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in ModerationAPI::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query,
+             ModerationAPI::Internal::Type::HashOf[ModerationAPI::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, ModerationAPI::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, ModerationAPI::Internal::Type::HashOf[ModerationAPI::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(ModerationAPI::RequestOptions, ModerationAPI::Internal::AnyHash) }
+    end
+  end
+end

data/lib/moderation_api/resources/account.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Account
+      # Get account details
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ModerationAPI::Models::AccountListResponse]
+      #
+      # @see ModerationAPI::Models::AccountListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "account",
+          model: ModerationAPI::Models::AccountListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModerationAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moderation_api/resources/actions/execute.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  module Resources
+    class Actions
+      class Execute
+        # Execute a moderation action on one or more content items.
+        #
+        # @overload execute(action_key:, author_ids: nil, content_ids: nil, duration: nil, queue_id: nil, value: nil, request_options: {})
+        #
+        # @param action_key [String] ID or key of the action to execute
+        #
+        # @param author_ids [Array<String>] IDs of the authors to apply the action to. Provide this or contentIds.
+        #
+        # @param content_ids [Array<String>] IDs of the content items to apply the action to. Provide this or authorIds.
+        #
+        # @param duration [Float] Optional duration in milliseconds for actions with timeouts
+        #
+        # @param queue_id [String] Optional queue ID if the action is queue-specific
+        #
+        # @param value [String] Optional value to provide with the action
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Actions::ExecuteExecuteResponse]
+        #
+        # @see ModerationAPI::Models::Actions::ExecuteExecuteParams
+        def execute(params)
+          parsed, options = ModerationAPI::Actions::ExecuteExecuteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "actions/execute",
+            body: parsed,
+            model: ModerationAPI::Models::Actions::ExecuteExecuteResponse,
+            options: options
+          )
+        end
+
+        # @deprecated
+        #
+        # Execute an action on a set of content items in a queue.
+        #
+        # @overload execute_by_id(action_id, author_ids: nil, content_ids: nil, queue_id: nil, value: nil, request_options: {})
+        #
+        # @param action_id [String] The ID or key of the action to execute.
+        #
+        # @param author_ids [Array<String>] IDs of the authors to apply the action to
+        #
+        # @param content_ids [Array<String>] The IDs of the content items to perform the action on.
+        #
+        # @param queue_id [String] The ID of the queue the action was performed from if any.
+        #
+        # @param value [String] The value of the action. Useful to set a reason for the action etc.
+        #
+        # @param request_options [ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [ModerationAPI::Models::Actions::ExecuteExecuteByIDResponse]
+        #
+        # @see ModerationAPI::Models::Actions::ExecuteExecuteByIDParams
+        def execute_by_id(action_id, params = {})
+          parsed, options = ModerationAPI::Actions::ExecuteExecuteByIDParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["actions/%1$s/execute", action_id],
+            body: parsed,
+            model: ModerationAPI::Models::Actions::ExecuteExecuteByIDResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [ModerationAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end