getstream-ruby 10.1.0 → 11.0.1

data/lib/getstream_ruby/generated/models/quality.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 Quality < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute viewer_interruption_note
+        #   @return [String]
+        attr_accessor :viewer_interruption_note
+        # @!attribute interruption_incidents
+        #   @return [Array<Incident>]
+        attr_accessor :interruption_incidents
+        # @!attribute connection_avg_jitter_ms
+        #   @return [Percentiles]
+        attr_accessor :connection_avg_jitter_ms
+        # @!attribute connection_avg_latency_ms
+        #   @return [Percentiles]
+        attr_accessor :connection_avg_latency_ms
+        # @!attribute score_bands_by_connection_pct
+        #   @return [ScoreBands]
+        attr_accessor :score_bands_by_connection_pct
+        # @!attribute score_bands_by_watch_time_pct
+        #   @return [ScoreBands]
+        attr_accessor :score_bands_by_watch_time_pct
+        # @!attribute p50_quality_score
+        #   @return [Float]
+        attr_accessor :p50_quality_score
+        # @!attribute p5_quality_score
+        #   @return [Float]
+        attr_accessor :p5_quality_score
+        # @!attribute viewer_interruption_rate_pct
+        #   @return [Float]
+        attr_accessor :viewer_interruption_rate_pct
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @viewer_interruption_note = attributes[:viewer_interruption_note] || attributes['viewer_interruption_note']
+          @interruption_incidents = attributes[:interruption_incidents] || attributes['interruption_incidents']
+          @connection_avg_jitter_ms = attributes[:connection_avg_jitter_ms] || attributes['connection_avg_jitter_ms']
+          @connection_avg_latency_ms = attributes[:connection_avg_latency_ms] || attributes['connection_avg_latency_ms']
+          @score_bands_by_connection_pct = attributes[:score_bands_by_connection_pct] || attributes['score_bands_by_connection_pct']
+          @score_bands_by_watch_time_pct = attributes[:score_bands_by_watch_time_pct] || attributes['score_bands_by_watch_time_pct']
+          @p50_quality_score = attributes[:p50_quality_score] || attributes['p50_quality_score'] || nil
+          @p5_quality_score = attributes[:p5_quality_score] || attributes['p5_quality_score'] || nil
+          @viewer_interruption_rate_pct = attributes[:viewer_interruption_rate_pct] || attributes['viewer_interruption_rate_pct'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            viewer_interruption_note: 'viewer_interruption_note',
+            interruption_incidents: 'interruption_incidents',
+            connection_avg_jitter_ms: 'connection_avg_jitter_ms',
+            connection_avg_latency_ms: 'connection_avg_latency_ms',
+            score_bands_by_connection_pct: 'score_bands_by_connection_pct',
+            score_bands_by_watch_time_pct: 'score_bands_by_watch_time_pct',
+            p50_quality_score: 'p50_quality_score',
+            p5_quality_score: 'p5_quality_score',
+            viewer_interruption_rate_pct: 'viewer_interruption_rate_pct'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ module GetStream
         #   @return [Object] Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [Array<SortParamRequest>]
         attr_accessor :sort
         # @!attribute filter
-        #   @return [Object]
+        #   @return [Object] Filters to apply to the query
         attr_accessor :filter
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions for appeals
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Array<SortParamRequest>] Array of sort parameters
         attr_accessor :sort
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Object] Filters to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -25,7 +25,7 @@ module GetStream
         #   @return [Array<CallParticipantResponse>] List of call participants
         attr_accessor :participants
         # @!attribute call
-        #   @return [CallResponse]
+        #   @return [CallResponse] Represents a call
         attr_accessor :call
 
         # Initialize with attributes

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

@@ -25,7 +25,7 @@ module GetStream
         #   @return [Array<SortParamRequest>]
         attr_accessor :sort
         # @!attribute filter
-        #   @return [Object]
+        #   @return [Object] Filter to apply to the query
         attr_accessor :filter
 
         # Initialize with attributes

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

@@ -30,6 +30,9 @@ module GetStream
         # @!attribute user_id
         #   @return [String]
         attr_accessor :user_id
+        # @!attribute member_custom_include
+        #   @return [Array<String>] Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each)
+        attr_accessor :member_custom_include
         # @!attribute sort
         #   @return [Array<SortParamRequest>] List of sort parameters
         attr_accessor :sort
@@ -43,7 +46,7 @@ module GetStream
         #   @return [Object]
         attr_accessor :sort_values
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes
@@ -56,6 +59,7 @@ module GetStream
           @predefined_filter = attributes[:predefined_filter] || attributes['predefined_filter'] || nil
           @state = attributes[:state] || attributes['state'] || nil
           @user_id = attributes[:user_id] || attributes['user_id'] || nil
+          @member_custom_include = attributes[:member_custom_include] || attributes['member_custom_include'] || nil
           @sort = attributes[:sort] || attributes['sort'] || nil
           @filter_conditions = attributes[:filter_conditions] || attributes['filter_conditions'] || nil
           @filter_values = attributes[:filter_values] || attributes['filter_values'] || nil
@@ -73,6 +77,7 @@ module GetStream
             predefined_filter: 'predefined_filter',
             state: 'state',
             user_id: 'user_id',
+            member_custom_include: 'member_custom_include',
             sort: 'sort',
             filter_conditions: 'filter_conditions',
             filter_values: 'filter_values',

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filters to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [Array<SortParamRequest>]
         attr_accessor :sort
         # @!attribute filter
-        #   @return [Object]
+        #   @return [Object] Filters to apply to the query
         attr_accessor :filter
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -19,7 +19,7 @@ module GetStream
         #   @return [DateTime] When the template was last updated
         attr_accessor :updated_at
         # @!attribute config
-        #   @return [FeedsModerationTemplateConfigPayload]
+        #   @return [FeedsModerationTemplateConfigPayload] Configuration for a feeds moderation template
         attr_accessor :config
 
         # Initialize with attributes

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

@@ -12,6 +12,9 @@ module GetStream
         # @!attribute exclude_expired_bans
         #   @return [Boolean] Whether to exclude expired bans or not
         attr_accessor :exclude_expired_bans
+        # @!attribute include_total
+        #   @return [Boolean] When true, the response includes the total number of bans matching the query filter (independent of limit and offset, capped at 100000)
+        attr_accessor :include_total
         # @!attribute limit
         #   @return [Integer] Number of records to return
         attr_accessor :limit
@@ -19,19 +22,20 @@ module GetStream
         #   @return [Integer] Number of records to offset
         attr_accessor :offset
         # @!attribute target_user_id
-        #   @return [String] Filter by the target user ID. For server-side requests only.
+        #   @return [String] Filter by the target user ID. Server-side: returns all bans against this user. Client-side: narrows the authenticated user's own bans to this target.
         attr_accessor :target_user_id
         # @!attribute user_id
         #   @return [String]
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
           @exclude_expired_bans = attributes[:exclude_expired_bans] || attributes['exclude_expired_bans'] || nil
+          @include_total = attributes[:include_total] || attributes['include_total'] || nil
           @limit = attributes[:limit] || attributes['limit'] || nil
           @offset = attributes[:offset] || attributes['offset'] || nil
           @target_user_id = attributes[:target_user_id] || attributes['target_user_id'] || nil
@@ -43,6 +47,7 @@ module GetStream
         def self.json_field_mappings
           {
             exclude_expired_bans: 'exclude_expired_bans',
+            include_total: 'include_total',
             limit: 'limit',
             offset: 'offset',
             target_user_id: 'target_user_id',

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

@@ -15,19 +15,24 @@ module GetStream
         # @!attribute bans
         #   @return [Array<FutureChannelBanResponse>] List of found future channel bans
         attr_accessor :bans
+        # @!attribute total
+        #   @return [Integer] Total number of bans matching the query filter, computed at query time and capped at 100000. Only present when include_total is set on the request; omitted when computing the total timed out
+        attr_accessor :total
 
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
           @duration = attributes[:duration] || attributes['duration']
           @bans = attributes[:bans] || attributes['bans']
+          @total = attributes[:total] || attributes['total'] || nil
         end
 
         # Override field mappings for JSON serialization
         def self.json_field_mappings
           {
             duration: 'duration',
-            bans: 'bans'
+            bans: 'bans',
+            total: 'total'
           }
         end
       end

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -34,7 +34,7 @@ module GetStream
         #   @return [Array<SortParamRequest>] Array of sort parameters
         attr_accessor :sort
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions to apply to the query
         attr_accessor :filter_conditions
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions for moderation configs
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [Array<SortParamRequest>]
         attr_accessor :sort
         # @!attribute filter
-        #   @return [Object]
+        #   @return [Object] Filter conditions for moderation flags
         attr_accessor :filter
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions for moderation logs
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter conditions for moderation rules
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -43,7 +43,7 @@ module GetStream
         #   @return [Object] Filter conditions for review queue items. Accepts built-in fields (e.g. status, channel_cid, severity, recommended_action) and customer-supplied moderation_payload.custom keys: any key that is not a built-in field is matched against the item's custom moderation data (e.g. {"location_id": "loc-42"}). Use filter_config.filterable_custom_keys to discover which custom keys the app exposes as chips.
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -37,7 +37,7 @@ module GetStream
         #   @return [Object] Filter to apply to the query
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Array<SortParamRequest>] Array of sort parameters
         attr_accessor :sort
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [DateTime] Date/time of creation
         attr_accessor :created_at
         # @!attribute channel
-        #   @return [ChannelResponse]
+        #   @return [ChannelResponse] Represents channel in chat
         attr_accessor :channel
         # @!attribute custom
         #   @return [Object]
@@ -52,7 +52,7 @@ module GetStream
         #   @return [Object]
         attr_accessor :channel_custom
         # @!attribute message
-        #   @return [MessageResponse]
+        #   @return [MessageResponse] Represents any chat message
         attr_accessor :message
         # @!attribute reaction
         #   @return [ReactionResponse]

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

@@ -16,7 +16,7 @@ module GetStream
         #   @return [String] The ID of the user who reacted.
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [DateTime] Date/time of creation
         attr_accessor :created_at
         # @!attribute channel
-        #   @return [ChannelResponse]
+        #   @return [ChannelResponse] Represents channel in chat
         attr_accessor :channel
         # @!attribute custom
         #   @return [Object]
@@ -52,7 +52,7 @@ module GetStream
         #   @return [Object]
         attr_accessor :channel_custom
         # @!attribute message
-        #   @return [MessageResponse]
+        #   @return [MessageResponse] Represents any chat message
         attr_accessor :message
         # @!attribute reaction
         #   @return [ReactionResponse]

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

@@ -28,7 +28,7 @@ module GetStream
         #   @return [Object]
         attr_accessor :custom
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Object] Custom data for this object
         attr_accessor :custom
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -16,13 +16,13 @@ module GetStream
         #   @return [String]
         attr_accessor :message_id
         # @!attribute channel
-        #   @return [ChannelResponse]
+        #   @return [ChannelResponse] Represents channel in chat
         attr_accessor :channel
         # @!attribute custom
         #   @return [Object]
         attr_accessor :custom
         # @!attribute message
-        #   @return [MessageResponse]
+        #   @return [MessageResponse] Represents any chat message
         attr_accessor :message
         # @!attribute type
         #   @return [String] The type of event: "reaction.updated" in this case

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [String] Duration of the request in milliseconds
         attr_accessor :duration
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -16,7 +16,7 @@ module GetStream
         #   @return [Integer]
         attr_accessor :unread_messages
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute last_delivered_at
         #   @return [DateTime]

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -28,13 +28,13 @@ module GetStream
         #   @return [DateTime]
         attr_accessor :remind_at
         # @!attribute channel
-        #   @return [ChannelResponse]
+        #   @return [ChannelResponse] Represents channel in chat
         attr_accessor :channel
         # @!attribute message
-        #   @return [MessageResponse]
+        #   @return [MessageResponse] Represents any chat message
         attr_accessor :message
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [String] Optional pre-authenticated trunk ID (from PreAuth no-auth flow)
         attr_accessor :trunk_id
         # @!attribute challenge
-        #   @return [SIPChallengeRequest]
+        #   @return [SIPChallengeRequest] SIP digest challenge authentication data
         attr_accessor :challenge
         # @!attribute sip_headers
         #   @return [Hash<String, String>] Optional SIP headers as key-value pairs

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

@@ -13,13 +13,13 @@ module GetStream
         #   @return [String]
         attr_accessor :duration
         # @!attribute credentials
-        #   @return [SipInboundCredentials]
+        #   @return [SipInboundCredentials] Credentials for SIP inbound call authentication
         attr_accessor :credentials
         # @!attribute sip_routing_rule
-        #   @return [SIPInboundRoutingRuleResponse]
+        #   @return [SIPInboundRoutingRuleResponse] SIP Inbound Routing Rule response
         attr_accessor :sip_routing_rule
         # @!attribute sip_trunk
-        #   @return [SIPTrunkResponse]
+        #   @return [SIPTrunkResponse] SIP trunk information
         attr_accessor :sip_trunk
 
         # Initialize with attributes

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -13,7 +13,7 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -88,7 +88,7 @@ module GetStream
         #   @return [AppealItemResponse]
         attr_accessor :appeal
         # @!attribute assigned_to
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :assigned_to
         # @!attribute call
         #   @return [ModerationCallResponse]
@@ -115,7 +115,7 @@ module GetStream
         #   @return [ChatMessageResponse]
         attr_accessor :message
         # @!attribute moderation_payload
-        #   @return [ModerationPayloadResponse]
+        #   @return [ModerationPayloadResponse] Content payload for moderation
         attr_accessor :moderation_payload
         # @!attribute reaction
         #   @return [Reaction]