getstream-ruby 12.1.1 → 13.0.0

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

@@ -12,6 +12,12 @@ module GetStream
         # @!attribute text
         #   @return [String] Option text
         attr_accessor :text
+        # @!attribute config_key
+        #   @return [String] Key of the moderation configuration to use. Server-side only.
+        attr_accessor :config_key
+        # @!attribute config_team
+        #   @return [String] Team associated with the configuration. Server-side only.
+        attr_accessor :config_team
         # @!attribute user_id
         #   @return [String]
         attr_accessor :user_id
@@ -26,6 +32,8 @@ module GetStream
         def initialize(attributes = {})
           super(attributes)
           @text = attributes[:text] || attributes['text']
+          @config_key = attributes[:config_key] || attributes['config_key'] || nil
+          @config_team = attributes[:config_team] || attributes['config_team'] || nil
           @user_id = attributes[:user_id] || attributes['user_id'] || nil
           @custom = attributes[:custom] || attributes['custom'] || nil
           @user = attributes[:user] || attributes['user'] || nil
@@ -35,6 +43,8 @@ module GetStream
         def self.json_field_mappings
           {
             text: 'text',
+            config_key: 'config_key',
+            config_team: 'config_team',
             user_id: 'user_id',
             custom: 'custom',
             user: 'user'

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

@@ -18,6 +18,12 @@ module GetStream
         # @!attribute allow_user_suggested_options
         #   @return [Boolean]
         attr_accessor :allow_user_suggested_options
+        # @!attribute config_key
+        #   @return [String] Key of the moderation configuration to use. Server-side only.
+        attr_accessor :config_key
+        # @!attribute config_team
+        #   @return [String] Team associated with the configuration. Server-side only.
+        attr_accessor :config_team
         # @!attribute description
         #   @return [String] A description of the poll
         attr_accessor :description
@@ -33,11 +39,14 @@ module GetStream
         # @!attribute max_votes_allowed
         #   @return [Integer] Indicates the maximum amount of votes a user can cast
         attr_accessor :max_votes_allowed
+        # @!attribute team
+        #   @return [String]
+        attr_accessor :team
         # @!attribute user_id
         #   @return [String]
         attr_accessor :user_id
         # @!attribute voting_visibility
-        #   @return [String]
+        #   @return [VotingVisibility] Represents the visibility of votes in a poll.
         attr_accessor :voting_visibility
         # @!attribute options
         #   @return [Array<PollOptionInput>]
@@ -55,11 +64,14 @@ module GetStream
           @name = attributes[:name] || attributes['name']
           @allow_answers = attributes[:allow_answers] || attributes['allow_answers'] || nil
           @allow_user_suggested_options = attributes[:allow_user_suggested_options] || attributes['allow_user_suggested_options'] || nil
+          @config_key = attributes[:config_key] || attributes['config_key'] || nil
+          @config_team = attributes[:config_team] || attributes['config_team'] || nil
           @description = attributes[:description] || attributes['description'] || nil
           @enforce_unique_vote = attributes[:enforce_unique_vote] || attributes['enforce_unique_vote'] || nil
           @id = attributes[:id] || attributes['id'] || nil
           @is_closed = attributes[:is_closed] || attributes['is_closed'] || nil
           @max_votes_allowed = attributes[:max_votes_allowed] || attributes['max_votes_allowed'] || nil
+          @team = attributes[:team] || attributes['team'] || nil
           @user_id = attributes[:user_id] || attributes['user_id'] || nil
           @voting_visibility = attributes[:voting_visibility] || attributes['voting_visibility'] || nil
           @options = attributes[:options] || attributes['options'] || nil
@@ -73,11 +85,14 @@ module GetStream
             name: 'name',
             allow_answers: 'allow_answers',
             allow_user_suggested_options: 'allow_user_suggested_options',
+            config_key: 'config_key',
+            config_team: 'config_team',
             description: 'description',
             enforce_unique_vote: 'enforce_unique_vote',
             id: 'id',
             is_closed: 'is_closed',
             max_votes_allowed: 'max_votes_allowed',
+            team: 'team',
             user_id: 'user_id',
             voting_visibility: 'voting_visibility',
             options: 'options',

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

@@ -9,6 +9,9 @@ module GetStream
       class CreateReminderRequest < GetStream::BaseModel
 
         # Model attributes
+        # @!attribute expires_at
+        #   @return [DateTime]
+        attr_accessor :expires_at
         # @!attribute remind_at
         #   @return [DateTime]
         attr_accessor :remind_at
@@ -22,6 +25,7 @@ module GetStream
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
+          @expires_at = attributes[:expires_at] || attributes['expires_at'] || nil
           @remind_at = attributes[:remind_at] || attributes['remind_at'] || nil
           @user_id = attributes[:user_id] || attributes['user_id'] || nil
           @user = attributes[:user] || attributes['user'] || nil
@@ -30,6 +34,7 @@ module GetStream
         # Override field mappings for JSON serialization
         def self.json_field_mappings
           {
+            expires_at: 'expires_at',
             remind_at: 'remind_at',
             user_id: 'user_id',
             user: 'user'

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class DeleteFeedsRetentionPolicyRequest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute policy
+        #   @return [String]
+        attr_accessor :policy
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @policy = attributes[:policy] || attributes['policy']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            policy: 'policy'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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 DeleteFeedsRetentionPolicyResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String] Duration of the request in milliseconds
+        attr_accessor :duration
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class DeleteHistoryWindowTeamsRequest < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute teams
+        #   @return [Array<String>] Teams to put back on the app's default history window, 1 to 10, each listed once. A team without full history is ignored
+        attr_accessor :teams
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @teams = attributes[:teams] || attributes['teams']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            teams: 'teams'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class DeleteHistoryWindowTeamsResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String] Duration of the request in milliseconds
+        attr_accessor :duration
+        # @!attribute teams
+        #   @return [Array<String>] The teams of the request that had full history and are now back on the default window
+        attr_accessor :teams
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @teams = attributes[:teams] || attributes['teams']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            teams: 'teams'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # How a ban or user deletion treats the user's messages.
+      class DeleteMessages < GetStream::BaseModel
+        # Empty model - inherits all functionality from BaseModel
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # Configuration for deleting the free-text poll answer a review item was raised for. Chat polls only. Deletion is permanent; the poll and other votes are kept.
+      class DeletePollAnswerRequestPayload < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute reason
+        #   @return [String] Reason for deletion
+        attr_accessor :reason
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @reason = attributes[:reason] || attributes['reason'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            reason: 'reason'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # Configuration for deleting the single poll option a review item was raised for. Deletion is permanent; the rest of the poll is kept.
+      class DeletePollOptionRequestPayload < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute option_id
+        #   @return [String] Option to delete. Required on an item for a whole poll (create or edit); defaults to the option an add_option / update_option item was raised for
+        attr_accessor :option_id
+        # @!attribute reason
+        #   @return [String] Reason for deletion
+        attr_accessor :reason
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @option_id = attributes[:option_id] || attributes['option_id'] || nil
+          @reason = attributes[:reason] || attributes['reason'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            option_id: 'option_id',
+            reason: 'reason'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # Configuration for poll deletion action. Poll deletion is always permanent.
+      class DeletePollRequestPayload < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute reason
+        #   @return [String] Reason for deletion
+        attr_accessor :reason
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @reason = attributes[:reason] || attributes['reason'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            reason: 'reason'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module GetStream
 
         # Model attributes
         # @!attribute policy
-        #   @return [String]
+        #   @return [RetentionPolicyType] What a retention policy applies to.
         attr_accessor :policy
 
         # Initialize with attributes

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class DeleteScheduledMessageResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String] Duration of the request in milliseconds
+        attr_accessor :duration
+        # @!attribute scheduled_message
+        #   @return [ScheduledMessageResponse] A message scheduled to be sent later
+        attr_accessor :scheduled_message
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @scheduled_message = attributes[:scheduled_message] || attributes['scheduled_message']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            scheduled_message: 'scheduled_message'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # The user's remaining interest tags, ordered by descending weight, then manually set tags before computed ones, then descending count, then ascending tag name
+      class DeleteUserInterestsResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String]
+        attr_accessor :duration
+        # @!attribute interests
+        #   @return [Array<InterestTagResponse>] Interest tags still set on the user
+        attr_accessor :interests
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @interests = attributes[:interests] || attributes['interests']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            interests: 'interests'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module GetStream
 
         # Model attributes
         # @!attribute delete_messages
-        #   @return [String] Message deletion mode: soft, pruning, or hard
+        #   @return [DeleteMessages] Message deletion mode: soft, pruning, or hard
         attr_accessor :delete_messages
         # @!attribute channel_cid
         #   @return [String] Optional: scope deletion to a single channel (alternative to app-wide deletion)

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

@@ -16,7 +16,7 @@ module GetStream
         #   @return [String] Calls delete mode.,  Affected calls are those that include exactly two members, one of whom is the user being deleted.,  * null or empty string - doesn't delete any calls,  * soft - marks user's calls and their related data as deleted (soft-delete),  * hard - deletes user's calls and their data completely (hard-delete)
         attr_accessor :calls
         # @!attribute conversations
-        #   @return [String] Conversation channels delete mode.,  Conversation channel is any channel which only has two members one of which is the user being deleted.,  * null or empty string - doesn't delete any conversation channels,  * soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled),  * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)
+        #   @return [String] Conversation channels delete mode.,  Conversation channel is any channel which only has two members one of which is the user being deleted.,  * null or empty string - doesn't delete any conversation channels, unless user is 'hard', in which case it defaults to 'hard',  * soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled),  * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled),  * keep - doesn't delete any conversation channels. Use it with user 'hard', where null or empty string defaults to 'hard'
         attr_accessor :conversations
         # @!attribute files
         #   @return [Boolean] Delete user files.,  * false or empty string - doesn't delete any files,  * true - deletes all files uploaded by the user, including images and attachments.
@@ -31,7 +31,7 @@ module GetStream
         #   @return [String]
         attr_accessor :new_channel_owner_id
         # @!attribute user
-        #   @return [String] User delete mode.,  * soft - marks user as deleted and retains all user data,  * pruning - marks user as deleted and nullifies user information,  * hard - deletes user completely. Requires 'hard' option for messages and conversations as well
+        #   @return [String] User delete mode.,  * soft - marks user as deleted and retains all user data,  * pruning - marks user as deleted and nullifies user information,  * hard - deletes user completely. Requires 'hard' option for messages, and 'hard' or 'keep' option for conversations
         attr_accessor :user
 
         # Initialize with attributes

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

@@ -5,7 +5,7 @@
 module GetStream
   module Generated
     module Models
-      # 
+      # The settings for the delivery receipt events.
       class DeliveryReceiptsResponse < GetStream::BaseModel
 
         # Model attributes

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT.
+
+module GetStream
+  module Generated
+    module Models
+      # 
+      class DetectedURLResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute url
+        #   @return [String] The URL as found.
+        attr_accessor :url
+        # @!attribute source
+        #   @return [String] Where it was found: `qr` (decoded from a QR code in an image), `ocr` (in text visible in an image) or `text` (in a moderated text).
+        attr_accessor :source
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @url = attributes[:url] || attributes['url']
+          @source = attributes[:source] || attributes['source'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            url: 'url',
+            source: 'source'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -5,18 +5,18 @@
 module GetStream
   module Generated
     module Models
-      # Response for Device
+      # An object representing a device which can receive push notifications.
       class DeviceResponse < GetStream::BaseModel
 
         # Model attributes
         # @!attribute created_at
-        #   @return [DateTime] Date/time of creation
+        #   @return [DateTime] The date when the device was created.
         attr_accessor :created_at
         # @!attribute id
-        #   @return [String] Device ID
+        #   @return [String] The device identifier.
         attr_accessor :id
         # @!attribute push_provider
-        #   @return [String] Push provider
+        #   @return [PushProviderName] Push provider
         attr_accessor :push_provider
         # @!attribute user_id
         #   @return [String] User ID

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

@@ -10,7 +10,7 @@ module GetStream
 
         # Model attributes
         # @!attribute mode
-        #   @return [String] Encryption mode. One of: available, disabled, auto-on
+        #   @return [FeatureActivationMode] Encryption mode. One of: available, disabled, auto-on
         attr_accessor :mode
 
         # Initialize with attributes

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

@@ -10,7 +10,7 @@ module GetStream
 
         # Model attributes
         # @!attribute mode
-        #   @return [String] the resolved encryption mode for the call
+        #   @return [FeatureActivationMode] the resolved encryption mode for the call
         attr_accessor :mode
 
         # Initialize with attributes

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

@@ -18,6 +18,9 @@ module GetStream
         # @!attribute score
         #   @return [Float]
         attr_accessor :score
+        # @!attribute time
+        #   @return [String]
+        attr_accessor :time
         # @!attribute verb
         #   @return [String]
         attr_accessor :verb
@@ -52,6 +55,7 @@ module GetStream
           @foreign_id = attributes[:foreign_id] || attributes['foreign_id'] || nil
           @id = attributes[:id] || attributes['id'] || nil
           @score = attributes[:score] || attributes['score'] || nil
+          @time = attributes[:time] || attributes['time'] || nil
           @verb = attributes[:verb] || attributes['verb'] || nil
           @to = attributes[:to] || attributes['to'] || nil
           @actor = attributes[:actor] || attributes['actor'] || nil
@@ -69,6 +73,7 @@ module GetStream
             foreign_id: 'foreign_id',
             id: 'id',
             score: 'score',
+            time: 'time',
             verb: 'verb',
             to: 'to',
             actor: 'actor',

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

@@ -16,7 +16,7 @@ module GetStream
         #   @return [String] Name/type of the collection
         attr_accessor :name
         # @!attribute status
-        #   @return [String] Enrichment status of the collection. One of: ok, notfound
+        #   @return [CollectionStatus] Enrichment status of the collection. One of: ok, notfound
         attr_accessor :status
         # @!attribute created_at
         #   @return [DateTime] When the collection was created