getstream-ruby 5.0.0 → 6.1.0

data/lib/getstream_ruby/generated/models/label_result_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class LabelResultResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute category
+        #   @return [String] Category
+        attr_accessor :category
+        # @!attribute content
+        #   @return [String] The moderated content
+        attr_accessor :content
+        # @!attribute content_type
+        #   @return [String]
+        attr_accessor :content_type
+        # @!attribute created_at
+        #   @return [DateTime] Timestamp
+        attr_accessor :created_at
+        # @!attribute harm_type
+        #   @return [String] High-level harm category
+        attr_accessor :harm_type
+        # @!attribute id
+        #   @return [String] Unique identifier
+        attr_accessor :id
+        # @!attribute language
+        #   @return [String] Detected language
+        attr_accessor :language
+        # @!attribute recommended_action
+        #   @return [String] Provider recommended action
+        attr_accessor :recommended_action
+        # @!attribute severity
+        #   @return [String] Severity level
+        attr_accessor :severity
+        # @!attribute labels
+        #   @return [Array<String>] Moderation labels
+        attr_accessor :labels
+        # @!attribute content_id
+        #   @return [String] Customer-supplied identifier for the moderated content
+        attr_accessor :content_id
+        # @!attribute directed_at
+        #   @return [String] Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.)
+        attr_accessor :directed_at
+        # @!attribute masked_content
+        #   @return [String] Content with blocklisted tokens masked (when a blocklist rule with action=mask rewrote the original)
+        attr_accessor :masked_content
+        # @!attribute policy
+        #   @return [String]
+        attr_accessor :policy
+        # @!attribute user_id
+        #   @return [String] Customer-supplied user identifier for the content author
+        attr_accessor :user_id
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @category = attributes[:category] || attributes['category']
+          @content = attributes[:content] || attributes['content']
+          @content_type = attributes[:content_type] || attributes['content_type']
+          @created_at = attributes[:created_at] || attributes['created_at']
+          @harm_type = attributes[:harm_type] || attributes['harm_type']
+          @id = attributes[:id] || attributes['id']
+          @language = attributes[:language] || attributes['language']
+          @recommended_action = attributes[:recommended_action] || attributes['recommended_action']
+          @severity = attributes[:severity] || attributes['severity']
+          @labels = attributes[:labels] || attributes['labels']
+          @content_id = attributes[:content_id] || attributes['content_id'] || nil
+          @directed_at = attributes[:directed_at] || attributes['directed_at'] || nil
+          @masked_content = attributes[:masked_content] || attributes['masked_content'] || nil
+          @policy = attributes[:policy] || attributes['policy'] || nil
+          @user_id = attributes[:user_id] || attributes['user_id'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            category: 'category',
+            content: 'content',
+            content_type: 'content_type',
+            created_at: 'created_at',
+            harm_type: 'harm_type',
+            id: 'id',
+            language: 'language',
+            recommended_action: 'recommended_action',
+            severity: 'severity',
+            labels: 'labels',
+            content_id: 'content_id',
+            directed_at: 'directed_at',
+            masked_content: 'masked_content',
+            policy: 'policy',
+            user_id: 'user_id'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/labels_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class LabelsRequest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute content
+        #   @return [String] Content to moderate
+        attr_accessor :content
+        # @!attribute category
+        #   @return [String] Optional category for filtering (max 128 chars)
+        attr_accessor :category
+        # @!attribute content_id
+        #   @return [String] Customer-supplied identifier for the moderated content, for tracing
+        attr_accessor :content_id
+        # @!attribute content_type
+        #   @return [String] Type of content: 'text' (default), 'message', or 'username'. Stored as-sent; only 'username' routes to the username moderation API.
+        attr_accessor :content_type
+        # @!attribute policy
+        #   @return [String] Optional moderation policy key (max 128 chars)
+        attr_accessor :policy
+        # @!attribute user_id
+        #   @return [String] Optional customer-supplied user identifier for the content author (max 256 chars). Enables filtering stored results by user_id.
+        attr_accessor :user_id
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @content = attributes[:content] || attributes['content']
+          @category = attributes[:category] || attributes['category'] || nil
+          @content_id = attributes[:content_id] || attributes['content_id'] || nil
+          @content_type = attributes[:content_type] || attributes['content_type'] || nil
+          @policy = attributes[:policy] || attributes['policy'] || nil
+          @user_id = attributes[:user_id] || attributes['user_id'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            content: 'content',
+            category: 'category',
+            content_id: 'content_id',
+            content_type: 'content_type',
+            policy: 'policy',
+            user_id: 'user_id'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/labels_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class LabelsResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String]
+        attr_accessor :duration
+        # @!attribute recommended_action
+        #   @return [String] Provider recommended action
+        attr_accessor :recommended_action
+        # @!attribute content_id
+        #   @return [String] Customer-supplied identifier for the moderated content, for tracing
+        attr_accessor :content_id
+        # @!attribute directed_at
+        #   @return [String] Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.), when the provider exposes it
+        attr_accessor :directed_at
+        # @!attribute harm_type
+        #   @return [String] High-level harm category
+        attr_accessor :harm_type
+        # @!attribute language
+        #   @return [String] Detected language
+        attr_accessor :language
+        # @!attribute masked_content
+        #   @return [String] Content with blocklisted tokens masked or substituted. Present only when a blocklist rewrote the original content.
+        attr_accessor :masked_content
+        # @!attribute severity
+        #   @return [String] Severity level
+        attr_accessor :severity
+        # @!attribute labels
+        #   @return [Array<String>] Moderation labels detected
+        attr_accessor :labels
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @recommended_action = attributes[:recommended_action] || attributes['recommended_action']
+          @content_id = attributes[:content_id] || attributes['content_id'] || nil
+          @directed_at = attributes[:directed_at] || attributes['directed_at'] || nil
+          @harm_type = attributes[:harm_type] || attributes['harm_type'] || nil
+          @language = attributes[:language] || attributes['language'] || nil
+          @masked_content = attributes[:masked_content] || attributes['masked_content'] || nil
+          @severity = attributes[:severity] || attributes['severity'] || nil
+          @labels = attributes[:labels] || attributes['labels'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            recommended_action: 'recommended_action',
+            content_id: 'content_id',
+            directed_at: 'directed_at',
+            harm_type: 'harm_type',
+            language: 'language',
+            masked_content: 'masked_content',
+            severity: 'severity',
+            labels: 'labels'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/location.rb

@@ -9,30 +9,25 @@ module GetStream
       class Location < GetStream::BaseModel
 
         # Model attributes
-        # @!attribute continent_code
-        #   @return [String]
-        attr_accessor :continent_code
-        # @!attribute country_iso_code
-        #   @return [String]
-        attr_accessor :country_iso_code
-        # @!attribute subdivision_iso_code
-        #   @return [String]
-        attr_accessor :subdivision_iso_code
+        # @!attribute lat
+        #   @return [Float] Latitude coordinate
+        attr_accessor :lat
+        # @!attribute lng
+        #   @return [Float] Longitude coordinate
+        attr_accessor :lng
 
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
-          @continent_code = attributes[:continent_code] || attributes['continent_code']
-          @country_iso_code = attributes[:country_iso_code] || attributes['country_iso_code']
-          @subdivision_iso_code = attributes[:subdivision_iso_code] || attributes['subdivision_iso_code']
+          @lat = attributes[:lat] || attributes['lat']
+          @lng = attributes[:lng] || attributes['lng']
         end
 
         # Override field mappings for JSON serialization
         def self.json_field_mappings
           {
-            continent_code: 'continent_code',
-            country_iso_code: 'country_iso_code',
-            subdivision_iso_code: 'subdivision_iso_code'
+            lat: 'lat',
+            lng: 'lng'
           }
         end
       end

data/lib/getstream_ruby/generated/models/message_new_event.rb

@@ -69,6 +69,9 @@ module GetStream
         # @!attribute channel_custom
         #   @return [Object]
         attr_accessor :channel_custom
+        # @!attribute grouped_unread_channels
+        #   @return [Hash<String, Integer>]
+        attr_accessor :grouped_unread_channels
         # @!attribute user
         #   @return [UserResponseCommonFields]
         attr_accessor :user
@@ -96,6 +99,7 @@ module GetStream
           @thread_participants = attributes[:thread_participants] || attributes['thread_participants'] || nil
           @channel = attributes[:channel] || attributes['channel'] || nil
           @channel_custom = attributes[:channel_custom] || attributes['channel_custom'] || nil
+          @grouped_unread_channels = attributes[:grouped_unread_channels] || attributes['grouped_unread_channels'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end
 
@@ -122,6 +126,7 @@ module GetStream
             thread_participants: 'thread_participants',
             channel: 'channel',
             channel_custom: 'channel_custom',
+            grouped_unread_channels: 'grouped_unread_channels',
             user: 'user'
           }
         end

data/lib/getstream_ruby/generated/models/moderation_action_config_response.rb

@@ -24,6 +24,9 @@ module GetStream
         # @!attribute order
         #   @return [Integer] Display order (lower numbers shown first)
         attr_accessor :order
+        # @!attribute id
+        #   @return [String]
+        attr_accessor :id
         # @!attribute queue_type
         #   @return [String] Queue type this action config belongs to
         attr_accessor :queue_type
@@ -39,6 +42,7 @@ module GetStream
           @entity_type = attributes[:entity_type] || attributes['entity_type']
           @icon = attributes[:icon] || attributes['icon']
           @order = attributes[:order] || attributes['order']
+          @id = attributes[:id] || attributes['id'] || nil
           @queue_type = attributes[:queue_type] || attributes['queue_type'] || nil
           @custom = attributes[:custom] || attributes['custom'] || nil
         end
@@ -51,6 +55,7 @@ module GetStream
             entity_type: 'entity_type',
             icon: 'icon',
             order: 'order',
+            id: 'id',
             queue_type: 'queue_type',
             custom: 'custom'
           }

data/lib/getstream_ruby/generated/models/moderation_dashboard_preferences.rb

@@ -24,6 +24,9 @@ module GetStream
         # @!attribute flag_user_on_flagged_content
         #   @return [Boolean]
         attr_accessor :flag_user_on_flagged_content
+        # @!attribute include_attachment_payload
+        #   @return [Boolean]
+        attr_accessor :include_attachment_payload
         # @!attribute media_queue_blur_enabled
         #   @return [Boolean]
         attr_accessor :media_queue_blur_enabled
@@ -48,6 +51,7 @@ module GetStream
           @disable_flagging_reviewed_entity = attributes[:disable_flagging_reviewed_entity] || attributes['disable_flagging_reviewed_entity'] || nil
           @escalation_queue_enabled = attributes[:escalation_queue_enabled] || attributes['escalation_queue_enabled'] || nil
           @flag_user_on_flagged_content = attributes[:flag_user_on_flagged_content] || attributes['flag_user_on_flagged_content'] || nil
+          @include_attachment_payload = attributes[:include_attachment_payload] || attributes['include_attachment_payload'] || nil
           @media_queue_blur_enabled = attributes[:media_queue_blur_enabled] || attributes['media_queue_blur_enabled'] || nil
           @allowed_moderation_action_reasons = attributes[:allowed_moderation_action_reasons] || attributes['allowed_moderation_action_reasons'] || nil
           @escalation_reasons = attributes[:escalation_reasons] || attributes['escalation_reasons'] || nil
@@ -63,6 +67,7 @@ module GetStream
             disable_flagging_reviewed_entity: 'disable_flagging_reviewed_entity',
             escalation_queue_enabled: 'escalation_queue_enabled',
             flag_user_on_flagged_content: 'flag_user_on_flagged_content',
+            include_attachment_payload: 'include_attachment_payload',
             media_queue_blur_enabled: 'media_queue_blur_enabled',
             allowed_moderation_action_reasons: 'allowed_moderation_action_reasons',
             escalation_reasons: 'escalation_reasons',

data/lib/getstream_ruby/generated/models/notification_mark_unread_event.rb

@@ -75,6 +75,9 @@ module GetStream
         # @!attribute channel_custom
         #   @return [Object]
         attr_accessor :channel_custom
+        # @!attribute grouped_unread_channels
+        #   @return [Hash<String, Integer>]
+        attr_accessor :grouped_unread_channels
         # @!attribute user
         #   @return [UserResponseCommonFields]
         attr_accessor :user
@@ -104,6 +107,7 @@ module GetStream
           @unread_threads = attributes[:unread_threads] || attributes['unread_threads'] || nil
           @channel = attributes[:channel] || attributes['channel'] || nil
           @channel_custom = attributes[:channel_custom] || attributes['channel_custom'] || nil
+          @grouped_unread_channels = attributes[:grouped_unread_channels] || attributes['grouped_unread_channels'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end
 
@@ -132,6 +136,7 @@ module GetStream
             unread_threads: 'unread_threads',
             channel: 'channel',
             channel_custom: 'channel_custom',
+            grouped_unread_channels: 'grouped_unread_channels',
             user: 'user'
           }
         end

data/lib/getstream_ruby/generated/models/query_activities_request.rb

@@ -18,6 +18,9 @@ module GetStream
         # @!attribute include_private_activities
         #   @return [Boolean]
         attr_accessor :include_private_activities
+        # @!attribute include_soft_deleted_activities
+        #   @return [Boolean] When true, include soft-deleted activities in the result.
+        attr_accessor :include_soft_deleted_activities
         # @!attribute limit
         #   @return [Integer]
         attr_accessor :limit
@@ -46,6 +49,7 @@ module GetStream
           @enrich_own_fields = attributes[:enrich_own_fields] || attributes['enrich_own_fields'] || nil
           @include_expired_activities = attributes[:include_expired_activities] || attributes['include_expired_activities'] || nil
           @include_private_activities = attributes[:include_private_activities] || attributes['include_private_activities'] || nil
+          @include_soft_deleted_activities = attributes[:include_soft_deleted_activities] || attributes['include_soft_deleted_activities'] || nil
           @limit = attributes[:limit] || attributes['limit'] || nil
           @next = attributes[:next] || attributes['next'] || nil
           @prev = attributes[:prev] || attributes['prev'] || nil
@@ -61,6 +65,7 @@ module GetStream
             enrich_own_fields: 'enrich_own_fields',
             include_expired_activities: 'include_expired_activities',
             include_private_activities: 'include_private_activities',
+            include_soft_deleted_activities: 'include_soft_deleted_activities',
             limit: 'limit',
             next: 'next',
             prev: 'prev',

data/lib/getstream_ruby/generated/models/query_call_session_stats_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class QueryCallSessionStatsRequest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute limit
+        #   @return [Integer]
+        attr_accessor :limit
+        # @!attribute next
+        #   @return [String]
+        attr_accessor :next
+        # @!attribute prev
+        #   @return [String]
+        attr_accessor :prev
+        # @!attribute sort
+        #   @return [Array<SortParamRequest>] Array of sort parameters
+        attr_accessor :sort
+        # @!attribute filter_conditions
+        #   @return [Object] Filter conditions to apply to the query
+        attr_accessor :filter_conditions
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @limit = attributes[:limit] || attributes['limit'] || nil
+          @next = attributes[:next] || attributes['next'] || nil
+          @prev = attributes[:prev] || attributes['prev'] || nil
+          @sort = attributes[:sort] || attributes['sort'] || nil
+          @filter_conditions = attributes[:filter_conditions] || attributes['filter_conditions'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            limit: 'limit',
+            next: 'next',
+            prev: 'prev',
+            sort: 'sort',
+            filter_conditions: 'filter_conditions'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/query_call_session_stats_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # Basic response information
+      class QueryCallSessionStatsResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String] Duration of the request in milliseconds
+        attr_accessor :duration
+        # @!attribute call_stats
+        #   @return [Array<CallStatsSessionResponse>]
+        attr_accessor :call_stats
+        # @!attribute next
+        #   @return [String]
+        attr_accessor :next
+        # @!attribute prev
+        #   @return [String]
+        attr_accessor :prev
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @call_stats = attributes[:call_stats] || attributes['call_stats']
+          @next = attributes[:next] || attributes['next'] || nil
+          @prev = attributes[:prev] || attributes['prev'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            call_stats: 'call_stats',
+            next: 'next',
+            prev: 'prev'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/query_comments_request.rb

@@ -10,7 +10,7 @@ module GetStream
 
         # Model attributes
         # @!attribute filter
-        #   @return [Object] MongoDB-style filter for querying comments
+        #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute id_around
         #   @return [String] Returns the comment with the specified ID along with surrounding comments for context
@@ -25,7 +25,7 @@ module GetStream
         #   @return [String]
         attr_accessor :prev
         # @!attribute sort
-        #   @return [String] first (oldest), last (newest) or top. One of: first, last, top, best, controversial
+        #   @return [String] Array of sort parameters
         attr_accessor :sort
         # @!attribute user_id
         #   @return [String]

data/lib/getstream_ruby/generated/models/query_feeds_usage_stats_response.rb

@@ -24,6 +24,9 @@ module GetStream
         # @!attribute openai_requests
         #   @return [DailyMetricStatsResponse]
         attr_accessor :openai_requests
+        # @!attribute emau
+        #   @return [EMAUStatsResponse]
+        attr_accessor :emau
 
         # Initialize with attributes
         def initialize(attributes = {})
@@ -33,6 +36,7 @@ module GetStream
           @api_requests = attributes[:api_requests] || attributes['api_requests']
           @follows = attributes[:follows] || attributes['follows']
           @openai_requests = attributes[:openai_requests] || attributes['openai_requests']
+          @emau = attributes[:emau] || attributes['emau'] || nil
         end
 
         # Override field mappings for JSON serialization
@@ -42,7 +46,8 @@ module GetStream
             activities: 'activities',
             api_requests: 'api_requests',
             follows: 'follows',
-            openai_requests: 'openai_requests'
+            openai_requests: 'openai_requests',
+            emau: 'emau'
           }
         end
       end

data/lib/getstream_ruby/generated/models/query_label_results_request.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class QueryLabelResultsRequest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute limit
+        #   @return [Integer]
+        attr_accessor :limit
+        # @!attribute next
+        #   @return [String]
+        attr_accessor :next
+        # @!attribute prev
+        #   @return [String]
+        attr_accessor :prev
+        # @!attribute user_id
+        #   @return [String]
+        attr_accessor :user_id
+        # @!attribute sort
+        #   @return [Array<SortParamRequest>] Sorting parameters
+        attr_accessor :sort
+        # @!attribute filter
+        #   @return [Object] Filter conditions
+        attr_accessor :filter
+        # @!attribute user
+        #   @return [UserRequest]
+        attr_accessor :user
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @limit = attributes[:limit] || attributes['limit'] || nil
+          @next = attributes[:next] || attributes['next'] || nil
+          @prev = attributes[:prev] || attributes['prev'] || nil
+          @user_id = attributes[:user_id] || attributes['user_id'] || nil
+          @sort = attributes[:sort] || attributes['sort'] || nil
+          @filter = attributes[:filter] || attributes['filter'] || nil
+          @user = attributes[:user] || attributes['user'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            limit: 'limit',
+            next: 'next',
+            prev: 'prev',
+            user_id: 'user_id',
+            sort: 'sort',
+            filter: 'filter',
+            user: 'user'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/query_label_results_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class QueryLabelResultsResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String]
+        attr_accessor :duration
+        # @!attribute label_results
+        #   @return [Array<LabelResultResponse>] List of moderation label results
+        attr_accessor :label_results
+        # @!attribute next
+        #   @return [String]
+        attr_accessor :next
+        # @!attribute prev
+        #   @return [String]
+        attr_accessor :prev
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @label_results = attributes[:label_results] || attributes['label_results']
+          @next = attributes[:next] || attributes['next'] || nil
+          @prev = attributes[:prev] || attributes['prev'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            label_results: 'label_results',
+            next: 'next',
+            prev: 'prev'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/query_reactions_request.rb

@@ -22,10 +22,10 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute sort
-        #   @return [Array<SortParamRequest>]
+        #   @return [Array<SortParamRequest>] Array of sort parameters
         attr_accessor :sort
         # @!attribute filter
-        #   @return [Object]
+        #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute user
         #   @return [UserRequest]