moderation_api 3.0.0 → 3.1.1

data/lib/moderation_api/models/operations/createaction_request.rb

@@ -11,147 +11,25 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The name of the action.
+        field :body, Models::Operations::CreateActionRequestBody, {'request': {'media_type': "application/json"}}
+        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
         field(
-          :name,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
-        )
-        # The IDs of the queues the action is available in.
-        field(
-          :filter_in_queue_ids,
-          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("filterInQueueIds")}}
-        )
-        # The possible values of the action. The user will be prompted to select one of these values when executing the action.
-        field(
-          :possible_values,
-          Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::CreateActionPossibleValueRequest)),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("possibleValues")}}
-        )
-        # User defined key of the action.
-        field(
-          :key,
+          :project_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("key")}}
-        )
-        # The description of the action.
-        field(
-          :description,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
-        )
-        # The type of the action.
-        field(
-          :type,
-          Crystalline::Nilable.new(Models::Operations::CreateActionTypeRequest),
-          {
-            'format_json': {
-              'letter_case': ::ModerationApi::Utils.field_name("type"),
-              'decoder': ::ModerationApi::Utils.enum_from_string(Models::Operations::CreateActionTypeRequest, true)
-            }
-          }
-        )
-        # Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status.
-        field(
-          :queue_behaviour,
-          Crystalline::Nilable.new(Models::Operations::CreateActionQueueBehaviourRequest),
-          {
-            'format_json': {
-              'letter_case': ::ModerationApi::Utils.field_name("queueBehaviour"),
-              'decoder': ::ModerationApi::Utils.enum_from_string(
-                Models::Operations::CreateActionQueueBehaviourRequest,
-                true
-              )
-            }
-          }
-        )
-        # Show the action in all queues, selected queues or no queues (to use via API only).
-        field(
-          :position,
-          Crystalline::Nilable.new(Models::Operations::CreateActionPositionRequest),
-          {
-            'format_json': {
-              'letter_case': ::ModerationApi::Utils.field_name("position"),
-              'decoder': ::ModerationApi::Utils.enum_from_string(Models::Operations::CreateActionPositionRequest, true)
-            }
-          }
-        )
-        # Whether the action requires a value to be executed.
-        field(
-          :value_required,
-          Crystalline::Nilable.new(Crystalline::Boolean.new),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("valueRequired")}}
-        )
-        # Whether the action allows any text to be entered as a value or if it must be one of the possible values.
-        field(
-          :free_text,
-          Crystalline::Nilable.new(Crystalline::Boolean.new),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("freeText")}}
-        )
-        # Whether the action is a built-in action or a custom one.
-        field(
-          :built_in,
-          Crystalline::Nilable.new(Crystalline::Boolean.new),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("builtIn")}}
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
         )
 
-        sig {
-          params(
-            name: ::String,
-            filter_in_queue_ids: T.nilable(T::Array[::String]),
-            possible_values: T.nilable(T::Array[Models::Operations::CreateActionPossibleValueRequest]),
-            key: T.nilable(::String),
-            description: T.nilable(::String),
-            type: T.nilable(Models::Operations::CreateActionTypeRequest),
-            queue_behaviour: T.nilable(Models::Operations::CreateActionQueueBehaviourRequest),
-            position: T.nilable(Models::Operations::CreateActionPositionRequest),
-            value_required: T.nilable(T::Boolean),
-            free_text: T.nilable(T::Boolean),
-            built_in: T.nilable(T::Boolean)
-          )
-            .void
-        }
-        def initialize(
-          name:,
-          filter_in_queue_ids: nil,
-          possible_values: nil,
-          key: nil,
-          description: nil,
-          type: nil,
-          queue_behaviour: Models::Operations::CreateActionQueueBehaviourRequest::NO_CHANGE,
-          position: Models::Operations::CreateActionPositionRequest::ALL_QUEUES,
-          value_required: false,
-          free_text: false,
-          built_in: false
-        )
-          @name = name
-          @filter_in_queue_ids = filter_in_queue_ids
-          @possible_values = possible_values
-          @key = key
-          @description = description
-          @type = type
-          @queue_behaviour = queue_behaviour
-          @position = position
-          @value_required = value_required
-          @free_text = free_text
-          @built_in = built_in
+        sig { params(body: Models::Operations::CreateActionRequestBody, project_id: T.nilable(::String)).void }
+        def initialize(body:, project_id: nil)
+          @body = body
+          @project_id = project_id
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
         def ==(other)
           return false unless other.is_a?(self.class)
-          return false unless @name == other.name
-          return false unless @filter_in_queue_ids == other.filter_in_queue_ids
-          return false unless @possible_values == other.possible_values
-          return false unless @key == other.key
-          return false unless @description == other.description
-          return false unless @type == other.type
-          return false unless @queue_behaviour == other.queue_behaviour
-          return false unless @position == other.position
-          return false unless @value_required == other.value_required
-          return false unless @free_text == other.free_text
-          return false unless @built_in == other.built_in
+          return false unless @body == other.body
+          return false unless @project_id == other.project_id
           true
         end
       end

data/lib/moderation_api/models/operations/createaction_request.rbi

@@ -6,69 +6,15 @@ class ModerationApi::Models::Operations::CreateActionRequest
 end
 
 class ModerationApi::Models::Operations::CreateActionRequest
-  def name
+  def body
   end
 
-  def name=(str_)
+  def body=(str_)
   end
 
-  def filter_in_queue_ids
+  def project_id
   end
 
-  def filter_in_queue_ids=(str_)
-  end
-
-  def possible_values
-  end
-
-  def possible_values=(str_)
-  end
-
-  def key
-  end
-
-  def key=(str_)
-  end
-
-  def description
-  end
-
-  def description=(str_)
-  end
-
-  def type
-  end
-
-  def type=(str_)
-  end
-
-  def queue_behaviour
-  end
-
-  def queue_behaviour=(str_)
-  end
-
-  def position
-  end
-
-  def position=(str_)
-  end
-
-  def value_required
-  end
-
-  def value_required=(str_)
-  end
-
-  def free_text
-  end
-
-  def free_text=(str_)
-  end
-
-  def built_in
-  end
-
-  def built_in=(str_)
+  def project_id=(str_)
   end
 end

data/lib/moderation_api/models/operations/createaction_requestbody.rb

@@ -0,0 +1,160 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class CreateActionRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The name of the action.
+        field(
+          :name,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
+        )
+        # The IDs of the queues the action is available in.
+        field(
+          :filter_in_queue_ids,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("filterInQueueIds")}}
+        )
+        # The possible values of the action. The user will be prompted to select one of these values when executing the action.
+        field(
+          :possible_values,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Operations::CreateActionPossibleValueRequest)),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("possibleValues")}}
+        )
+        # User defined key of the action.
+        field(
+          :key,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("key")}}
+        )
+        # The description of the action.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
+        )
+        # The type of the action.
+        field(
+          :type,
+          Crystalline::Nilable.new(Models::Operations::CreateActionTypeRequest),
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("type"),
+              'decoder': ::ModerationApi::Utils.enum_from_string(Models::Operations::CreateActionTypeRequest, true)
+            }
+          }
+        )
+        # Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status.
+        field(
+          :queue_behaviour,
+          Crystalline::Nilable.new(Models::Operations::CreateActionQueueBehaviourRequest),
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("queueBehaviour"),
+              'decoder': ::ModerationApi::Utils.enum_from_string(
+                Models::Operations::CreateActionQueueBehaviourRequest,
+                true
+              )
+            }
+          }
+        )
+        # Show the action in all queues, selected queues or no queues (to use via API only).
+        field(
+          :position,
+          Crystalline::Nilable.new(Models::Operations::CreateActionPositionRequest),
+          {
+            'format_json': {
+              'letter_case': ::ModerationApi::Utils.field_name("position"),
+              'decoder': ::ModerationApi::Utils.enum_from_string(Models::Operations::CreateActionPositionRequest, true)
+            }
+          }
+        )
+        # Whether the action requires a value to be executed.
+        field(
+          :value_required,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("valueRequired")}}
+        )
+        # Whether the action allows any text to be entered as a value or if it must be one of the possible values.
+        field(
+          :free_text,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("freeText")}}
+        )
+        # Whether the action is a built-in action or a custom one.
+        field(
+          :built_in,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("builtIn")}}
+        )
+
+        sig {
+          params(
+            name: ::String,
+            filter_in_queue_ids: T.nilable(T::Array[::String]),
+            possible_values: T.nilable(T::Array[Models::Operations::CreateActionPossibleValueRequest]),
+            key: T.nilable(::String),
+            description: T.nilable(::String),
+            type: T.nilable(Models::Operations::CreateActionTypeRequest),
+            queue_behaviour: T.nilable(Models::Operations::CreateActionQueueBehaviourRequest),
+            position: T.nilable(Models::Operations::CreateActionPositionRequest),
+            value_required: T.nilable(T::Boolean),
+            free_text: T.nilable(T::Boolean),
+            built_in: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(
+          name:,
+          filter_in_queue_ids: nil,
+          possible_values: nil,
+          key: nil,
+          description: nil,
+          type: nil,
+          queue_behaviour: Models::Operations::CreateActionQueueBehaviourRequest::NO_CHANGE,
+          position: Models::Operations::CreateActionPositionRequest::ALL_QUEUES,
+          value_required: false,
+          free_text: false,
+          built_in: false
+        )
+          @name = name
+          @filter_in_queue_ids = filter_in_queue_ids
+          @possible_values = possible_values
+          @key = key
+          @description = description
+          @type = type
+          @queue_behaviour = queue_behaviour
+          @position = position
+          @value_required = value_required
+          @free_text = free_text
+          @built_in = built_in
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @name == other.name
+          return false unless @filter_in_queue_ids == other.filter_in_queue_ids
+          return false unless @possible_values == other.possible_values
+          return false unless @key == other.key
+          return false unless @description == other.description
+          return false unless @type == other.type
+          return false unless @queue_behaviour == other.queue_behaviour
+          return false unless @position == other.position
+          return false unless @value_required == other.value_required
+          return false unless @free_text == other.free_text
+          return false unless @built_in == other.built_in
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moderation_api/models/operations/createaction_requestbody.rbi

@@ -0,0 +1,74 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::CreateActionRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::CreateActionRequestBody
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def filter_in_queue_ids
+  end
+
+  def filter_in_queue_ids=(str_)
+  end
+
+  def possible_values
+  end
+
+  def possible_values=(str_)
+  end
+
+  def key
+  end
+
+  def key=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def queue_behaviour
+  end
+
+  def queue_behaviour=(str_)
+  end
+
+  def position
+  end
+
+  def position=(str_)
+  end
+
+  def value_required
+  end
+
+  def value_required=(str_)
+  end
+
+  def free_text
+  end
+
+  def free_text=(str_)
+  end
+
+  def built_in
+  end
+
+  def built_in=(str_)
+  end
+end

data/lib/moderation_api/models/operations/createauthor_request.rb

@@ -11,119 +11,25 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # External ID of the user, typically the ID of the author in your database.
+        field :body, Models::Operations::CreateAuthorRequestBody, {'request': {'media_type': "application/json"}}
+        # The project to act on, when you call with an organization key. Optional when the organization has one project. A project key acts on its own project: naming another one is an error.
         field(
-          :external_id,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("external_id"), required: true}}
-        )
-        # Additional metadata provided by your system. We recommend including any relevant information that may assist in the moderation process.
-        field(
-          :metadata,
-          Crystalline::Nilable.new(Models::Operations::CreateAuthorMetadata),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("metadata")}}
-        )
-        # Timestamp when author first appeared
-        field(
-          :first_seen,
-          Crystalline::Nilable.new(::Float),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("first_seen")}}
-        )
-        # Timestamp of last activity
-        field(
-          :last_seen,
-          Crystalline::Nilable.new(::Float),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("last_seen")}}
-        )
-        # URL of the author's profile picture
-        field(
-          :profile_picture,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("profile_picture")}}
-        )
-        # URL of the author's external profile
-        field(
-          :external_link,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("external_link")}}
-        )
-        # Author name or identifier
-        field(
-          :name,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name")}}
-        )
-        # Author email address
-        field(
-          :email,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("email")}}
-        )
-        # The author's company or organization
-        field(
-          :company,
+          :project_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("company")}}
-        )
-
-        field(
-          :manual_trust_level,
-          Crystalline::Nilable.new(::Float),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("manual_trust_level")}}
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
         )
 
-        sig {
-          params(
-            external_id: ::String,
-            metadata: T.nilable(Models::Operations::CreateAuthorMetadata),
-            first_seen: T.nilable(::Float),
-            last_seen: T.nilable(::Float),
-            profile_picture: T.nilable(::String),
-            external_link: T.nilable(::String),
-            name: T.nilable(::String),
-            email: T.nilable(::String),
-            company: T.nilable(::String),
-            manual_trust_level: T.nilable(::Float)
-          )
-            .void
-        }
-        def initialize(
-          external_id:,
-          metadata: nil,
-          first_seen: nil,
-          last_seen: nil,
-          profile_picture: nil,
-          external_link: nil,
-          name: nil,
-          email: nil,
-          company: nil,
-          manual_trust_level: nil
-        )
-          @external_id = external_id
-          @metadata = metadata
-          @first_seen = first_seen
-          @last_seen = last_seen
-          @profile_picture = profile_picture
-          @external_link = external_link
-          @name = name
-          @email = email
-          @company = company
-          @manual_trust_level = manual_trust_level
+        sig { params(body: Models::Operations::CreateAuthorRequestBody, project_id: T.nilable(::String)).void }
+        def initialize(body:, project_id: nil)
+          @body = body
+          @project_id = project_id
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
         def ==(other)
           return false unless other.is_a?(self.class)
-          return false unless @external_id == other.external_id
-          return false unless @metadata == other.metadata
-          return false unless @first_seen == other.first_seen
-          return false unless @last_seen == other.last_seen
-          return false unless @profile_picture == other.profile_picture
-          return false unless @external_link == other.external_link
-          return false unless @name == other.name
-          return false unless @email == other.email
-          return false unless @company == other.company
-          return false unless @manual_trust_level == other.manual_trust_level
+          return false unless @body == other.body
+          return false unless @project_id == other.project_id
           true
         end
       end

data/lib/moderation_api/models/operations/createauthor_request.rbi

@@ -6,63 +6,15 @@ class ModerationApi::Models::Operations::CreateAuthorRequest
 end
 
 class ModerationApi::Models::Operations::CreateAuthorRequest
-  def external_id
+  def body
   end
 
-  def external_id=(str_)
+  def body=(str_)
   end
 
-  def metadata
+  def project_id
   end
 
-  def metadata=(str_)
-  end
-
-  def first_seen
-  end
-
-  def first_seen=(str_)
-  end
-
-  def last_seen
-  end
-
-  def last_seen=(str_)
-  end
-
-  def profile_picture
-  end
-
-  def profile_picture=(str_)
-  end
-
-  def external_link
-  end
-
-  def external_link=(str_)
-  end
-
-  def name
-  end
-
-  def name=(str_)
-  end
-
-  def email
-  end
-
-  def email=(str_)
-  end
-
-  def company
-  end
-
-  def company=(str_)
-  end
-
-  def manual_trust_level
-  end
-
-  def manual_trust_level=(str_)
+  def project_id=(str_)
   end
 end