moderation_api 3.0.0 → 3.1.0

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

@@ -0,0 +1,132 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class CreateAuthorRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # External ID of the user, typically the ID of the author in your database.
+        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,
+          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")}}
+        )
+
+        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
+        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
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::CreateAuthorRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::CreateAuthorRequestBody
+  def external_id
+  end
+
+  def external_id=(str_)
+  end
+
+  def metadata
+  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_)
+  end
+end

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

@@ -11,50 +11,25 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The webhook's name, used to identify it in the dashboard
+        field :body, Models::Operations::CreateWebhookRequestBody, {'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 webhook's URL. We'll call this URL when an event occurs.
-        field :url, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("url"), required: true}}
-        # Event types this webhook subscribes to. One webhook URL receives all events you list here.
-        field(
-          :event_types,
-          Crystalline::Array.new(Models::Operations::CreateWebhookEventTypeRequest),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("eventTypes"), required: true}}
-        )
-        # The webhook's description
-        field(
-          :description,
+          :project_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
         )
 
-        sig {
-          params(
-            name: ::String,
-            url: ::String,
-            event_types: T::Array[Models::Operations::CreateWebhookEventTypeRequest],
-            description: T.nilable(::String)
-          )
-            .void
-        }
-        def initialize(name:, url:, event_types:, description: nil)
-          @name = name
-          @url = url
-          @event_types = event_types
-          @description = description
+        sig { params(body: Models::Operations::CreateWebhookRequestBody, 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 @url == other.url
-          return false unless @event_types == other.event_types
-          return false unless @description == other.description
+          return false unless @body == other.body
+          return false unless @project_id == other.project_id
           true
         end
       end

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

@@ -6,27 +6,15 @@ class ModerationApi::Models::Operations::CreateWebhookRequest
 end
 
 class ModerationApi::Models::Operations::CreateWebhookRequest
-  def name
+  def body
   end
 
-  def name=(str_)
+  def body=(str_)
   end
 
-  def url
+  def project_id
   end
 
-  def url=(str_)
-  end
-
-  def event_types
-  end
-
-  def event_types=(str_)
-  end
-
-  def description
-  end
-
-  def description=(str_)
+  def project_id=(str_)
   end
 end

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

@@ -0,0 +1,63 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class CreateWebhookRequestBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The webhook's name, used to identify it in the dashboard
+        field(
+          :name,
+          ::String,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("name"), required: true}}
+        )
+        # The webhook's URL. We'll call this URL when an event occurs.
+        field :url, ::String, {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("url"), required: true}}
+        # Event types this webhook subscribes to. One webhook URL receives all events you list here.
+        field(
+          :event_types,
+          Crystalline::Array.new(Models::Operations::CreateWebhookEventTypeRequest),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("eventTypes"), required: true}}
+        )
+        # The webhook's description
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("description")}}
+        )
+
+        sig {
+          params(
+            name: ::String,
+            url: ::String,
+            event_types: T::Array[Models::Operations::CreateWebhookEventTypeRequest],
+            description: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(name:, url:, event_types:, description: nil)
+          @name = name
+          @url = url
+          @event_types = event_types
+          @description = description
+        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 @url == other.url
+          return false unless @event_types == other.event_types
+          return false unless @description == other.description
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::CreateWebhookRequestBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::CreateWebhookRequestBody
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def url
+  end
+
+  def url=(str_)
+  end
+
+  def event_types
+  end
+
+  def event_types=(str_)
+  end
+
+  def description
+  end
+
+  def description=(str_)
+  end
+end

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

@@ -13,16 +13,24 @@ module ModerationApi
 
         # The ID of the action to delete.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
+        # 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(
+          :project_id,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
+        )
 
-        sig { params(id: ::String).void }
-        def initialize(id:)
+        sig { params(id: ::String, project_id: T.nilable(::String)).void }
+        def initialize(id:, project_id: nil)
           @id = id
+          @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 @id == other.id
+          return false unless @project_id == other.project_id
           true
         end
       end

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

@@ -11,4 +11,10 @@ class ModerationApi::Models::Operations::DeleteActionRequest
 
   def id=(str_)
   end
+
+  def project_id
+  end
+
+  def project_id=(str_)
+  end
 end

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

@@ -13,16 +13,24 @@ module ModerationApi
 
         # Either external ID or the ID assigned by moderation API.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
+        # 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(
+          :project_id,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
+        )
 
-        sig { params(id: ::String).void }
-        def initialize(id:)
+        sig { params(id: ::String, project_id: T.nilable(::String)).void }
+        def initialize(id:, project_id: nil)
           @id = id
+          @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 @id == other.id
+          return false unless @project_id == other.project_id
           true
         end
       end

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

@@ -11,4 +11,10 @@ class ModerationApi::Models::Operations::DeleteAuthorRequest
 
   def id=(str_)
   end
+
+  def project_id
+  end
+
+  def project_id=(str_)
+  end
 end

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

@@ -13,16 +13,24 @@ module ModerationApi
 
         # The ID of the webhook to delete.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
+        # 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(
+          :project_id,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
+        )
 
-        sig { params(id: ::String).void }
-        def initialize(id:)
+        sig { params(id: ::String, project_id: T.nilable(::String)).void }
+        def initialize(id:, project_id: nil)
           @id = id
+          @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 @id == other.id
+          return false unless @project_id == other.project_id
           true
         end
       end

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

@@ -11,4 +11,10 @@ class ModerationApi::Models::Operations::DeleteWebhookRequest
 
   def id=(str_)
   end
+
+  def project_id
+  end
+
+  def project_id=(str_)
+  end
 end

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

@@ -6,77 +6,30 @@
 module ModerationApi
   module Models
     module Operations
-      # Input parameters
+
       class ExecuteActionRequest
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # ID or key of the action to execute
-        field(
-          :action_key,
-          ::String,
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("actionKey"), required: true}}
-        )
-        # IDs of the content items to apply the action to. Provide this or authorIds.
-        field(
-          :content_ids,
-          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("contentIds")}}
-        )
-        # IDs of the authors to apply the action to. Provide this or contentIds.
-        field(
-          :author_ids,
-          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("authorIds")}}
-        )
-        # Optional value to provide with the action
-        field(
-          :value,
-          Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("value")}}
-        )
-        # Optional queue ID if the action is queue-specific
+        field :body, Models::Operations::ExecuteActionRequestBody, {'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(
-          :queue_id,
+          :project_id,
           Crystalline::Nilable.new(::String),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("queueId")}}
-        )
-        # Optional duration in milliseconds for actions with timeouts
-        field(
-          :duration,
-          Crystalline::Nilable.new(::Float),
-          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("duration")}}
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
         )
 
-        sig {
-          params(
-            action_key: ::String,
-            content_ids: T.nilable(T::Array[::String]),
-            author_ids: T.nilable(T::Array[::String]),
-            value: T.nilable(::String),
-            queue_id: T.nilable(::String),
-            duration: T.nilable(::Float)
-          )
-            .void
-        }
-        def initialize(action_key:, content_ids: nil, author_ids: nil, value: nil, queue_id: nil, duration: nil)
-          @action_key = action_key
-          @content_ids = content_ids
-          @author_ids = author_ids
-          @value = value
-          @queue_id = queue_id
-          @duration = duration
+        sig { params(body: Models::Operations::ExecuteActionRequestBody, 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 @action_key == other.action_key
-          return false unless @content_ids == other.content_ids
-          return false unless @author_ids == other.author_ids
-          return false unless @value == other.value
-          return false unless @queue_id == other.queue_id
-          return false unless @duration == other.duration
+          return false unless @body == other.body
+          return false unless @project_id == other.project_id
           true
         end
       end

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

@@ -6,39 +6,15 @@ class ModerationApi::Models::Operations::ExecuteActionRequest
 end
 
 class ModerationApi::Models::Operations::ExecuteActionRequest
-  def action_key
+  def body
   end
 
-  def action_key=(str_)
+  def body=(str_)
   end
 
-  def content_ids
+  def project_id
   end
 
-  def content_ids=(str_)
-  end
-
-  def author_ids
-  end
-
-  def author_ids=(str_)
-  end
-
-  def value
-  end
-
-  def value=(str_)
-  end
-
-  def queue_id
-  end
-
-  def queue_id=(str_)
-  end
-
-  def duration
-  end
-
-  def duration=(str_)
+  def project_id=(str_)
   end
 end