moderation_api 3.1.1 → 3.2.0

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

@@ -11,13 +11,19 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # The queue ID
+        # The queue ID.
         field :id, ::String, {'path_param': {'field_name': "id", 'style': "simple", 'explode': false}}
 
         field(
-          :sort_field,
-          Crystalline::Nilable.new(Models::Operations::SortField),
-          {'query_param': {'field_name': "sortField", 'style': "form", 'explode': true}}
+          :sort,
+          Crystalline::Nilable.new(Models::Operations::Sort),
+          {'query_param': {'field_name': "sort", 'style': "form", 'explode': true}}
+        )
+
+        field(
+          :include_resolved,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'query_param': {'field_name': "includeResolved", 'style': "form", 'explode': true}}
         )
 
         field(
@@ -33,35 +39,29 @@ module ModerationApi
         )
 
         field(
-          :after_date,
-          Crystalline::Nilable.new(::String),
-          {'query_param': {'field_name': "afterDate", 'style': "form", 'explode': true}}
-        )
-
-        field(
-          :before_date,
+          :author_id,
           Crystalline::Nilable.new(::String),
-          {'query_param': {'field_name': "beforeDate", 'style': "form", 'explode': true}}
+          {'query_param': {'field_name': "authorId", 'style': "form", 'explode': true}}
         )
 
         field(
-          :include_resolved,
-          Crystalline::Nilable.new(Crystalline::Boolean.new),
-          {'query_param': {'field_name': "includeResolved", 'style': "form", 'explode': true}}
+          :filtered_action_ids,
+          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
+          {'query_param': {'field_name': "filteredActionIds", 'style': "form", 'explode': true}}
         )
 
         field(
-          :author_id,
+          :after_date,
           Crystalline::Nilable.new(::String),
-          {'query_param': {'field_name': "authorId", 'style': "form", 'explode': true}}
+          {'query_param': {'field_name': "afterDate", 'style': "form", 'explode': true}}
         )
 
         field(
-          :filtered_action_ids,
-          Crystalline::Nilable.new(Crystalline::Array.new(::String)),
-          {'query_param': {'field_name': "filteredActionIds", 'style': "form", 'explode': true}}
+          :before_date,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "beforeDate", 'style': "form", 'explode': true}}
         )
-        # 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.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),
@@ -79,77 +79,67 @@ module ModerationApi
           Crystalline::Nilable.new(::Integer),
           {'query_param': {'field_name': "pageSize", 'style': "form", 'explode': true}}
         )
-        # Sort direction
-        field(
-          :sort_direction,
-          Crystalline::Nilable.new(Models::Operations::ListQueueItemsSortDirection),
-          {'query_param': {'field_name': "sortDirection", 'style': "form", 'explode': true}}
-        )
 
         sig {
           params(
             id: ::String,
-            sort_field: T.nilable(Models::Operations::SortField),
+            sort: T.nilable(Models::Operations::Sort),
+            include_resolved: T.nilable(T::Boolean),
             conversation_ids: T.nilable(T::Array[::String]),
             labels: T.nilable(T::Array[::String]),
-            after_date: T.nilable(::String),
-            before_date: T.nilable(::String),
-            include_resolved: T.nilable(T::Boolean),
             author_id: T.nilable(::String),
             filtered_action_ids: T.nilable(T::Array[::String]),
+            after_date: T.nilable(::String),
+            before_date: T.nilable(::String),
             project_id: T.nilable(::String),
             page: T.nilable(::Integer),
-            page_size: T.nilable(::Integer),
-            sort_direction: T.nilable(Models::Operations::ListQueueItemsSortDirection)
+            page_size: T.nilable(::Integer)
           )
             .void
         }
         def initialize(
           id:,
-          sort_field: nil,
+          sort: nil,
+          include_resolved: nil,
           conversation_ids: nil,
           labels: nil,
-          after_date: nil,
-          before_date: nil,
-          include_resolved: nil,
           author_id: nil,
           filtered_action_ids: nil,
+          after_date: nil,
+          before_date: nil,
           project_id: nil,
           page: 1,
-          page_size: 20,
-          sort_direction: Models::Operations::ListQueueItemsSortDirection::DESC
+          page_size: 20
         )
           @id = id
-          @sort_field = sort_field
+          @sort = sort
+          @include_resolved = include_resolved
           @conversation_ids = conversation_ids
           @labels = labels
-          @after_date = after_date
-          @before_date = before_date
-          @include_resolved = include_resolved
           @author_id = author_id
           @filtered_action_ids = filtered_action_ids
+          @after_date = after_date
+          @before_date = before_date
           @project_id = project_id
           @page = page
           @page_size = page_size
-          @sort_direction = sort_direction
         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 @sort_field == other.sort_field
+          return false unless @sort == other.sort
+          return false unless @include_resolved == other.include_resolved
           return false unless @conversation_ids == other.conversation_ids
           return false unless @labels == other.labels
-          return false unless @after_date == other.after_date
-          return false unless @before_date == other.before_date
-          return false unless @include_resolved == other.include_resolved
           return false unless @author_id == other.author_id
           return false unless @filtered_action_ids == other.filtered_action_ids
+          return false unless @after_date == other.after_date
+          return false unless @before_date == other.before_date
           return false unless @project_id == other.project_id
           return false unless @page == other.page
           return false unless @page_size == other.page_size
-          return false unless @sort_direction == other.sort_direction
           true
         end
       end

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

@@ -12,52 +12,52 @@ class ModerationApi::Models::Operations::ListQueueItemsRequest
   def id=(str_)
   end
 
-  def sort_field
+  def sort
   end
 
-  def sort_field=(str_)
+  def sort=(str_)
   end
 
-  def conversation_ids
+  def include_resolved
   end
 
-  def conversation_ids=(str_)
+  def include_resolved=(str_)
   end
 
-  def labels
+  def conversation_ids
   end
 
-  def labels=(str_)
+  def conversation_ids=(str_)
   end
 
-  def after_date
+  def labels
   end
 
-  def after_date=(str_)
+  def labels=(str_)
   end
 
-  def before_date
+  def author_id
   end
 
-  def before_date=(str_)
+  def author_id=(str_)
   end
 
-  def include_resolved
+  def filtered_action_ids
   end
 
-  def include_resolved=(str_)
+  def filtered_action_ids=(str_)
   end
 
-  def author_id
+  def after_date
   end
 
-  def author_id=(str_)
+  def after_date=(str_)
   end
 
-  def filtered_action_ids
+  def before_date
   end
 
-  def filtered_action_ids=(str_)
+  def before_date=(str_)
   end
 
   def project_id
@@ -77,10 +77,4 @@ class ModerationApi::Models::Operations::ListQueueItemsRequest
 
   def page_size=(str_)
   end
-
-  def sort_direction
-  end
-
-  def sort_direction=(str_)
-  end
 end

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

@@ -14,7 +14,7 @@ module ModerationApi
         # The items on this page.
         field(
           :data,
-          Crystalline::Array.new(Models::Operations::ListQueueItemsData),
+          Crystalline::Array.new(Models::Components::QueueItem),
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("data"), required: true}}
         )
         # Where this page is in the full list.
@@ -24,10 +24,7 @@ module ModerationApi
           {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("pagination"), required: true}}
         )
 
-        sig {
-          params(data: T::Array[Models::Operations::ListQueueItemsData], pagination: Models::Components::Pagination)
-            .void
-        }
+        sig { params(data: T::Array[Models::Components::QueueItem], pagination: Models::Components::Pagination).void }
         def initialize(data:, pagination:)
           @data = data
           @pagination = pagination

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

@@ -0,0 +1,53 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+
+      class ListQueuesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
+        field(
+          :project_id,
+          Crystalline::Nilable.new(::String),
+          {'header': {'field_name': "Project-Id", 'style': "simple", 'explode': false}}
+        )
+
+        field(
+          :page,
+          Crystalline::Nilable.new(::Integer),
+          {'query_param': {'field_name': "page", 'style': "form", 'explode': true}}
+        )
+
+        field(
+          :page_size,
+          Crystalline::Nilable.new(::Integer),
+          {'query_param': {'field_name': "pageSize", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(project_id: T.nilable(::String), page: T.nilable(::Integer), page_size: T.nilable(::Integer)).void
+        }
+        def initialize(project_id: nil, page: 1, page_size: 20)
+          @project_id = project_id
+          @page = page
+          @page_size = page_size
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @project_id == other.project_id
+          return false unless @page == other.page
+          return false unless @page_size == other.page_size
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::ListQueuesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::ListQueuesRequest
+  def project_id
+  end
+
+  def project_id=(str_)
+  end
+
+  def page
+  end
+
+  def page=(str_)
+  end
+
+  def page_size
+  end
+
+  def page_size=(str_)
+  end
+end

data/lib/moderation_api/models/operations/listqueues_response.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 ListQueuesResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+        sig { returns(T.proc.returns(T.nilable(ListQueuesResponse))) }
+        attr_accessor :next_page
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # Successful response
+        field :object, Crystalline::Nilable.new(Models::Operations::ListQueuesResponseBody)
+
+        sig {
+          params(
+            content_type: ::String,
+            status_code: ::Integer,
+            raw_response: ::Faraday::Response,
+            object: T.nilable(Models::Operations::ListQueuesResponseBody)
+          )
+            .void
+        }
+        def initialize(content_type:, status_code:, raw_response:, object: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @object = object
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @object == other.object
+          true
+        end
+
+        def each
+          page = self
+          loop do
+            yield page
+            next_page = page.next_page.call if page.next_page
+            break if next_page.nil?
+            page = T.must(next_page)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::ListQueuesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::ListQueuesResponse
+  def content_type
+  end
+
+  def content_type=(str_)
+  end
+
+  def status_code
+  end
+
+  def status_code=(str_)
+  end
+
+  def raw_response
+  end
+
+  def raw_response=(str_)
+  end
+
+  def object
+  end
+
+  def object=(str_)
+  end
+end

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

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # Successful response
+      class ListQueuesResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The items on this page.
+        field(
+          :data,
+          Crystalline::Array.new(Models::Components::Queue),
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("data"), required: true}}
+        )
+        # Where this page is in the full list.
+        field(
+          :pagination,
+          Models::Components::Pagination,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("pagination"), required: true}}
+        )
+
+        sig { params(data: T::Array[Models::Components::Queue], pagination: Models::Components::Pagination).void }
+        def initialize(data:, pagination:)
+          @data = data
+          @pagination = pagination
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @data == other.data
+          return false unless @pagination == other.pagination
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class ModerationApi::Models::Operations::ListQueuesResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class ModerationApi::Models::Operations::ListQueuesResponseBody
+  def data
+  end
+
+  def data=(str_)
+  end
+
+  def pagination
+  end
+
+  def pagination=(str_)
+  end
+end

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

@@ -11,7 +11,7 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # 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.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

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

@@ -11,7 +11,7 @@ module ModerationApi
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # 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.
+        # The project to act on, by ID or name. Required with an organization key unless the key reaches only one project; list projects with GET /projects. A project key acts on its own project and needs no value: naming another one is an error.
         field(
           :project_id,
           Crystalline::Nilable.new(::String),

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

@@ -0,0 +1,112 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module ModerationApi
+  module Models
+    module Operations
+      # The same counts for the window of equal length just before this one. Compare with `totals` to see the trend.
+      class PreviousPeriod
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Requests received. Every request counts, also repeats and edits of the same content.
+        field(
+          :requests,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("requests"), required: true}}
+        )
+        # Requests that were flagged.
+        field(
+          :flagged,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagged"), required: true}}
+        )
+        # The share of requests that were flagged: flagged / requests. 0 when there were no requests.
+        field(
+          :flag_rate,
+          ::Float,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flagRate"), required: true}}
+        )
+        # Requests with the recommendation "allow". Includes content that was not flagged.
+        field(
+          :allowed,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("allowed"), required: true}}
+        )
+        # Requests with the recommendation "reject". All of them were flagged.
+        field(
+          :rejected,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("rejected"), required: true}}
+        )
+        # Requests with the recommendation "review". This counts requests, not the deduplicated items in the review queue.
+        field(
+          :sent_to_review,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("sentToReview"), required: true}}
+        )
+        # Flagged requests that were settled without human review: rejected plus flaggedButAllowed.
+        field(
+          :handled_automatically,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("handledAutomatically"), required: true}}
+        )
+        # Flagged requests that were allowed without human review.
+        field(
+          :flagged_but_allowed,
+          ::Integer,
+          {'format_json': {'letter_case': ::ModerationApi::Utils.field_name("flaggedButAllowed"), required: true}}
+        )
+
+        sig {
+          params(
+            requests: ::Integer,
+            flagged: ::Integer,
+            flag_rate: ::Float,
+            allowed: ::Integer,
+            rejected: ::Integer,
+            sent_to_review: ::Integer,
+            handled_automatically: ::Integer,
+            flagged_but_allowed: ::Integer
+          )
+            .void
+        }
+        def initialize(
+          requests:,
+          flagged:,
+          flag_rate:,
+          allowed:,
+          rejected:,
+          sent_to_review:,
+          handled_automatically:,
+          flagged_but_allowed:
+        )
+          @requests = requests
+          @flagged = flagged
+          @flag_rate = flag_rate
+          @allowed = allowed
+          @rejected = rejected
+          @sent_to_review = sent_to_review
+          @handled_automatically = handled_automatically
+          @flagged_but_allowed = flagged_but_allowed
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @requests == other.requests
+          return false unless @flagged == other.flagged
+          return false unless @flag_rate == other.flag_rate
+          return false unless @allowed == other.allowed
+          return false unless @rejected == other.rejected
+          return false unless @sent_to_review == other.sent_to_review
+          return false unless @handled_automatically == other.handled_automatically
+          return false unless @flagged_but_allowed == other.flagged_but_allowed
+          true
+        end
+      end
+    end
+  end
+end