getstream-ruby 10.1.0 → 11.0.0

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class Audience < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute avg_concurrent_viewers
+        #   @return [Integer]
+        attr_accessor :avg_concurrent_viewers
+        # @!attribute hours_watched
+        #   @return [Float]
+        attr_accessor :hours_watched
+        # @!attribute peak_concurrent_viewers
+        #   @return [Integer]
+        attr_accessor :peak_concurrent_viewers
+        # @!attribute unique_viewers
+        #   @return [Integer]
+        attr_accessor :unique_viewers
+        # @!attribute viewer_connections
+        #   @return [Integer]
+        attr_accessor :viewer_connections
+        # @!attribute concurrency_by_minute
+        #   @return [Array<ConcurrencyMinute>]
+        attr_accessor :concurrency_by_minute
+        # @!attribute peak_at
+        #   @return [String]
+        attr_accessor :peak_at
+        # @!attribute ramp_up_min_to_90pct_peak
+        #   @return [Integer]
+        attr_accessor :ramp_up_min_to_90pct_peak
+        # @!attribute retention_at_90pct_mark
+        #   @return [Float]
+        attr_accessor :retention_at_90pct_mark
+        # @!attribute retention_at_midpoint
+        #   @return [Float]
+        attr_accessor :retention_at_midpoint
+        # @!attribute shape
+        #   @return [String]
+        attr_accessor :shape
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @avg_concurrent_viewers = attributes[:avg_concurrent_viewers] || attributes['avg_concurrent_viewers']
+          @hours_watched = attributes[:hours_watched] || attributes['hours_watched']
+          @peak_concurrent_viewers = attributes[:peak_concurrent_viewers] || attributes['peak_concurrent_viewers']
+          @unique_viewers = attributes[:unique_viewers] || attributes['unique_viewers']
+          @viewer_connections = attributes[:viewer_connections] || attributes['viewer_connections']
+          @concurrency_by_minute = attributes[:concurrency_by_minute] || attributes['concurrency_by_minute']
+          @peak_at = attributes[:peak_at] || attributes['peak_at'] || nil
+          @ramp_up_min_to_90pct_peak = attributes[:ramp_up_min_to_90pct_peak] || attributes['ramp_up_min_to_90pct_peak'] || nil
+          @retention_at_90pct_mark = attributes[:retention_at_90pct_mark] || attributes['retention_at_90pct_mark'] || nil
+          @retention_at_midpoint = attributes[:retention_at_midpoint] || attributes['retention_at_midpoint'] || nil
+          @shape = attributes[:shape] || attributes['shape'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            avg_concurrent_viewers: 'avg_concurrent_viewers',
+            hours_watched: 'hours_watched',
+            peak_concurrent_viewers: 'peak_concurrent_viewers',
+            unique_viewers: 'unique_viewers',
+            viewer_connections: 'viewer_connections',
+            concurrency_by_minute: 'concurrency_by_minute',
+            peak_at: 'peak_at',
+            ramp_up_min_to_90pct_peak: 'ramp_up_min_to_90pct_peak',
+            retention_at_90pct_mark: 'retention_at_90pct_mark',
+            retention_at_midpoint: 'retention_at_midpoint',
+            shape: 'shape'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [FlagMessageDetailsResponse]
         attr_accessor :message_details
         # @!attribute result
-        #   @return [MessageModerationResult]
+        #   @return [MessageModerationResult] Result of the message moderation
         attr_accessor :result
 
         # Initialize with attributes

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

@@ -12,6 +12,9 @@ module GetStream
         # @!attribute created_at
         #   @return [DateTime] When the ban was created
         attr_accessor :created_at
+        # @!attribute channel_cid
+        #   @return [String] The channel this ban applies to. Empty if this is an app-wide (global) ban rather than a per-channel ban.
+        attr_accessor :channel_cid
         # @!attribute expires
         #   @return [DateTime] When the ban expires
         attr_accessor :expires
@@ -21,20 +24,25 @@ module GetStream
         # @!attribute shadow
         #   @return [Boolean] Whether this is a shadow ban
         attr_accessor :shadow
+        # @!attribute channel
+        #   @return [ChannelMetadata]
+        attr_accessor :channel
         # @!attribute created_by
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :created_by
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
           @created_at = attributes[:created_at] || attributes['created_at']
+          @channel_cid = attributes[:channel_cid] || attributes['channel_cid'] || nil
           @expires = attributes[:expires] || attributes['expires'] || nil
           @reason = attributes[:reason] || attributes['reason'] || nil
           @shadow = attributes[:shadow] || attributes['shadow'] || nil
+          @channel = attributes[:channel] || attributes['channel'] || nil
           @created_by = attributes[:created_by] || attributes['created_by'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end
@@ -43,9 +51,11 @@ module GetStream
         def self.json_field_mappings
           {
             created_at: 'created_at',
+            channel_cid: 'channel_cid',
             expires: 'expires',
             reason: 'reason',
             shadow: 'shadow',
+            channel: 'channel',
             created_by: 'created_by',
             user: 'user'
           }

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

@@ -34,7 +34,7 @@ module GetStream
         #   @return [Integer] Duration of the ban in minutes
         attr_accessor :timeout
         # @!attribute banned_by
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :banned_by
 
         # Initialize with attributes

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

@@ -22,13 +22,13 @@ module GetStream
         #   @return [Boolean]
         attr_accessor :shadow
         # @!attribute banned_by
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :banned_by
         # @!attribute channel
-        #   @return [ChannelResponse]
+        #   @return [ChannelResponse] Represents channel in chat
         attr_accessor :channel
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Object] Optional filter on reaction_type or created_at
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Object] Optional filter on reaction_type or created_at
         attr_accessor :filter
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -36,6 +36,9 @@ module GetStream
         # @!attribute id
         #   @return [String]
         attr_accessor :id
+        # @!attribute owner_user_id
+        #   @return [String]
+        attr_accessor :owner_user_id
         # @!attribute team
         #   @return [String]
         attr_accessor :team
@@ -55,6 +58,7 @@ module GetStream
           @words = attributes[:words] || attributes['words']
           @created_at = attributes[:created_at] || attributes['created_at'] || nil
           @id = attributes[:id] || attributes['id'] || nil
+          @owner_user_id = attributes[:owner_user_id] || attributes['owner_user_id'] || nil
           @team = attributes[:team] || attributes['team'] || nil
           @updated_at = attributes[:updated_at] || attributes['updated_at'] || nil
         end
@@ -71,6 +75,7 @@ module GetStream
             words: 'words',
             created_at: 'created_at',
             id: 'id',
+            owner_user_id: 'owner_user_id',
             team: 'team',
             updated_at: 'updated_at'
           }

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

@@ -16,7 +16,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/blocked_user_event.rb

@@ -16,13 +16,13 @@ module GetStream
         #   @return [DateTime]
         attr_accessor :created_at
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute type
         #   @return [String] The type of event: "call.blocked_user" in this case
         attr_accessor :type
         # @!attribute blocked_by_user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :blocked_by_user
 
         # Initialize with attributes

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

@@ -19,10 +19,10 @@ module GetStream
         #   @return [String] ID of the user who blocked another user
         attr_accessor :user_id
         # @!attribute blocked_user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :blocked_user
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -22,7 +22,7 @@ module GetStream
         #   @return [DateTime] When the folder was last updated
         attr_accessor :updated_at
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute custom
         #   @return [Object] Custom data for the folder

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

@@ -25,7 +25,7 @@ module GetStream
         #   @return [ActivityResponse]
         attr_accessor :activity
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute activity_id
         #   @return [String]

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class BroadcastDailyRollup < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute broadcasts
+        #   @return [Integer]
+        attr_accessor :broadcasts
+        # @!attribute day
+        #   @return [String]
+        attr_accessor :day
+        # @!attribute dead_air_s
+        #   @return [Integer]
+        attr_accessor :dead_air_s
+        # @!attribute hours_watched
+        #   @return [Float]
+        attr_accessor :hours_watched
+        # @!attribute incident_windows
+        #   @return [Integer]
+        attr_accessor :incident_windows
+        # @!attribute max_peak_concurrent_viewers
+        #   @return [Integer]
+        attr_accessor :max_peak_concurrent_viewers
+        # @!attribute note
+        #   @return [String]
+        attr_accessor :note
+        # @!attribute schema_version
+        #   @return [String]
+        attr_accessor :schema_version
+        # @!attribute source_drops
+        #   @return [Integer]
+        attr_accessor :source_drops
+        # @!attribute unique_viewers_sum
+        #   @return [Integer]
+        attr_accessor :unique_viewers_sum
+        # @!attribute top_broadcasts
+        #   @return [Array<TopBroadcast>]
+        attr_accessor :top_broadcasts
+        # @!attribute poor_viewers_by_cause
+        #   @return [PoorByCause]
+        attr_accessor :poor_viewers_by_cause
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @broadcasts = attributes[:broadcasts] || attributes['broadcasts']
+          @day = attributes[:day] || attributes['day']
+          @dead_air_s = attributes[:dead_air_s] || attributes['dead_air_s']
+          @hours_watched = attributes[:hours_watched] || attributes['hours_watched']
+          @incident_windows = attributes[:incident_windows] || attributes['incident_windows']
+          @max_peak_concurrent_viewers = attributes[:max_peak_concurrent_viewers] || attributes['max_peak_concurrent_viewers']
+          @note = attributes[:note] || attributes['note']
+          @schema_version = attributes[:schema_version] || attributes['schema_version']
+          @source_drops = attributes[:source_drops] || attributes['source_drops']
+          @unique_viewers_sum = attributes[:unique_viewers_sum] || attributes['unique_viewers_sum']
+          @top_broadcasts = attributes[:top_broadcasts] || attributes['top_broadcasts']
+          @poor_viewers_by_cause = attributes[:poor_viewers_by_cause] || attributes['poor_viewers_by_cause']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            broadcasts: 'broadcasts',
+            day: 'day',
+            dead_air_s: 'dead_air_s',
+            hours_watched: 'hours_watched',
+            incident_windows: 'incident_windows',
+            max_peak_concurrent_viewers: 'max_peak_concurrent_viewers',
+            note: 'note',
+            schema_version: 'schema_version',
+            source_drops: 'source_drops',
+            unique_viewers_sum: 'unique_viewers_sum',
+            top_broadcasts: 'top_broadcasts',
+            poor_viewers_by_cause: 'poor_viewers_by_cause'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class BroadcastDigest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute schema_version
+        #   @return [String]
+        attr_accessor :schema_version
+        # @!attribute audience
+        #   @return [Audience]
+        attr_accessor :audience
+        # @!attribute broadcast
+        #   @return [BroadcastInfo]
+        attr_accessor :broadcast
+        # @!attribute coverage
+        #   @return [Coverage]
+        attr_accessor :coverage
+        # @!attribute joins
+        #   @return [Joins]
+        attr_accessor :joins
+        # @!attribute poor_tail
+        #   @return [PoorTail]
+        attr_accessor :poor_tail
+        # @!attribute quality
+        #   @return [Quality]
+        attr_accessor :quality
+        # @!attribute segments
+        #   @return [Segments]
+        attr_accessor :segments
+        # @!attribute source
+        #   @return [SourceHealth]
+        attr_accessor :source
+        # @!attribute viewers
+        #   @return [ViewerBehavior]
+        attr_accessor :viewers
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @schema_version = attributes[:schema_version] || attributes['schema_version']
+          @audience = attributes[:audience] || attributes['audience']
+          @broadcast = attributes[:broadcast] || attributes['broadcast']
+          @coverage = attributes[:coverage] || attributes['coverage']
+          @joins = attributes[:joins] || attributes['joins']
+          @poor_tail = attributes[:poor_tail] || attributes['poor_tail']
+          @quality = attributes[:quality] || attributes['quality']
+          @segments = attributes[:segments] || attributes['segments']
+          @source = attributes[:source] || attributes['source']
+          @viewers = attributes[:viewers] || attributes['viewers']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            schema_version: 'schema_version',
+            audience: 'audience',
+            broadcast: 'broadcast',
+            coverage: 'coverage',
+            joins: 'joins',
+            poor_tail: 'poor_tail',
+            quality: 'quality',
+            segments: 'segments',
+            source: 'source',
+            viewers: 'viewers'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/broadcast_info.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 BroadcastInfo < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute app_id
+        #   @return [Integer]
+        attr_accessor :app_id
+        # @!attribute call_cid
+        #   @return [String]
+        attr_accessor :call_cid
+        # @!attribute call_session_id
+        #   @return [String]
+        attr_accessor :call_session_id
+        # @!attribute call_type
+        #   @return [String]
+        attr_accessor :call_type
+        # @!attribute duration_min
+        #   @return [Float]
+        attr_accessor :duration_min
+        # @!attribute ended_at
+        #   @return [String]
+        attr_accessor :ended_at
+        # @!attribute started_at
+        #   @return [String]
+        attr_accessor :started_at
+        # @!attribute creators
+        #   @return [Array<String>]
+        attr_accessor :creators
+        # @!attribute source_mode
+        #   @return [String]
+        attr_accessor :source_mode
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @app_id = attributes[:app_id] || attributes['app_id']
+          @call_cid = attributes[:call_cid] || attributes['call_cid']
+          @call_session_id = attributes[:call_session_id] || attributes['call_session_id']
+          @call_type = attributes[:call_type] || attributes['call_type']
+          @duration_min = attributes[:duration_min] || attributes['duration_min']
+          @ended_at = attributes[:ended_at] || attributes['ended_at']
+          @started_at = attributes[:started_at] || attributes['started_at']
+          @creators = attributes[:creators] || attributes['creators']
+          @source_mode = attributes[:source_mode] || attributes['source_mode'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            app_id: 'app_id',
+            call_cid: 'call_cid',
+            call_session_id: 'call_session_id',
+            call_type: 'call_type',
+            duration_min: 'duration_min',
+            ended_at: 'ended_at',
+            started_at: 'started_at',
+            creators: 'creators',
+            source_mode: 'source_mode'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/broadcast_segment.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 BroadcastSegment < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute key
+        #   @return [String]
+        attr_accessor :key
+        # @!attribute sessions
+        #   @return [Integer]
+        attr_accessor :sessions
+        # @!attribute avg_quality_score
+        #   @return [Float]
+        attr_accessor :avg_quality_score
+        # @!attribute p5_quality_score
+        #   @return [Float]
+        attr_accessor :p5_quality_score
+        # @!attribute poor_pct
+        #   @return [Float]
+        attr_accessor :poor_pct
+        # @!attribute share_pct
+        #   @return [Float]
+        attr_accessor :share_pct
+        # @!attribute watch_share_pct
+        #   @return [Float]
+        attr_accessor :watch_share_pct
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @key = attributes[:key] || attributes['key']
+          @sessions = attributes[:sessions] || attributes['sessions']
+          @avg_quality_score = attributes[:avg_quality_score] || attributes['avg_quality_score'] || nil
+          @p5_quality_score = attributes[:p5_quality_score] || attributes['p5_quality_score'] || nil
+          @poor_pct = attributes[:poor_pct] || attributes['poor_pct'] || nil
+          @share_pct = attributes[:share_pct] || attributes['share_pct'] || nil
+          @watch_share_pct = attributes[:watch_share_pct] || attributes['watch_share_pct'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            key: 'key',
+            sessions: 'sessions',
+            avg_quality_score: 'avg_quality_score',
+            p5_quality_score: 'p5_quality_score',
+            poor_pct: 'poor_pct',
+            share_pct: 'share_pct',
+            watch_share_pct: 'watch_share_pct'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -13,10 +13,10 @@ module GetStream
         #   @return [Boolean]
         attr_accessor :enabled
         # @!attribute hls
-        #   @return [HLSSettingsResponse]
+        #   @return [HLSSettingsResponse] HLSSettings is the payload for HLS settings
         attr_accessor :hls
         # @!attribute rtmp
-        #   @return [RTMPSettingsResponse]
+        #   @return [RTMPSettingsResponse] RTMPSettingsResponse is the payload for RTMP settings
         attr_accessor :rtmp
 
         # Initialize with attributes

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

@@ -19,22 +19,22 @@ module GetStream
         #   @return [String]
         attr_accessor :user_id
         # @!attribute mark_reviewed
-        #   @return [MarkReviewedRequestPayload]
+        #   @return [MarkReviewedRequestPayload] Configuration for mark reviewed action
         attr_accessor :mark_reviewed
         # @!attribute reject_appeal
-        #   @return [RejectAppealRequestPayload]
+        #   @return [RejectAppealRequestPayload] Configuration for rejecting an appeal
         attr_accessor :reject_appeal
         # @!attribute restore
-        #   @return [RestoreActionRequestPayload]
+        #   @return [RestoreActionRequestPayload] Configuration for restore action
         attr_accessor :restore
         # @!attribute unban
-        #   @return [UnbanActionRequestPayload]
+        #   @return [UnbanActionRequestPayload] Configuration for unban moderation action
         attr_accessor :unban
         # @!attribute unblock
-        #   @return [UnblockActionRequestPayload]
+        #   @return [UnblockActionRequestPayload] Configuration for unblock action
         attr_accessor :unblock
         # @!attribute user
-        #   @return [UserRequest]
+        #   @return [UserRequest] User request object
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -16,7 +16,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/bulk_upsert_action_config_request.rb

@@ -16,7 +16,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/call_accepted_event.rb

@@ -16,10 +16,10 @@ module GetStream
         #   @return [DateTime]
         attr_accessor :created_at
         # @!attribute call
-        #   @return [CallResponse]
+        #   @return [CallResponse] Represents a call
         attr_accessor :call
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute type
         #   @return [String] The type of event: "call.accepted" in this case

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

@@ -31,7 +31,7 @@ module GetStream
         #   @return [Boolean]
         attr_accessor :translated
         # @!attribute user
-        #   @return [UserResponse]
+        #   @return [UserResponse] User response object
         attr_accessor :user
         # @!attribute service
         #   @return [String]