getstream-ruby 0.1.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9701e2be0391333b58fc3451e7f231d9b8eb6cc2dfe3228384f60a5d145342c2
-  data.tar.gz: e4260302ee416d20159ae12721f6e355bbf7ca750e2efde99f9599b564e00845
+  metadata.gz: 84b2977b2aae3ce190547f54299379081211a58e0f84938ce8898f0b4a380b59
+  data.tar.gz: d6e6da9bec863de451a6012d5756a519722430eda9eae28eb626aa2e446ce2f3
 SHA512:
-  metadata.gz: 5f7e8ba3ad221f4006c99b2d3833625f5cc786c66e7d287bc150e60d019a6cd56c6f2b67a0dd97f45ab35e082df0e68b7a7590e49fc18c5d94c5f8d128c3acea
-  data.tar.gz: de655a311d3da9f6b8973a0bd5f4561957fe0e42a983e2f5d0f293b20b5f09715f52c3b086764f0b13bff26274a7d48c3c9f39bf875127fcc314b9072a18161d
+  metadata.gz: 3030513009ac52219a1d13f7ca0897d0dfb5dacbd3e21cf567ea5ba7c676b2a3b73d0b4eb01e199e7f5e648a78101710651bb0b3c6187ee1ced538d925681558
+  data.tar.gz: d8e0757f5b7b03729041874c8c372d924a5d432dd6a15699798b98317598e3671f744695a98876203b2e4dffdecba11ea900394d9323024a1c3134931e4e00cb

data/lib/getstream_ruby/generated/base_model.rb

@@ -13,7 +13,14 @@ module GetStream
       end
     end
 
-    # Convert to hash
+    # Class method to define which fields should be omitted when empty (like Go's omitempty)
+    # Override this in subclasses to specify fields that should be excluded from JSON serialization when empty
+    # @return [Array<Symbol>] Array of field names to omit when empty
+    def self.omit_empty_fields
+      []
+    end
+
+    # Convert to hash (used for equality, inspect, etc.)
     def to_h
       instance_variables.each_with_object({}) do |var, hash|
         key = var.to_s.delete('@').to_sym
@@ -22,9 +29,27 @@ module GetStream
       end
     end
 
-    # Convert to JSON
+    # Convert to JSON with optional field filtering
+    # This is the Ruby-idiomatic way: filter only for JSON, keep to_h clean
+    # Automatically omits nil values (optional fields default to nil, like Go pointers)
     def to_json(*args)
-      to_h.to_json(*args)
+      hash = to_h
+      omit_fields = self.class.omit_empty_fields
+      
+      # Filter out nil values and empty fields for JSON serialization
+      hash = hash.reject do |key, value|
+        # Always omit nil values (optional fields default to nil)
+        next true if value.nil?
+        
+        # For fields in omit_empty_fields, also omit empty strings/arrays/hashes
+        if omit_fields.include?(key)
+          value == "" || (value.respond_to?(:empty?) && value.empty?)
+        else
+          false
+        end
+      end
+      
+      hash.to_json(*args)
     end
 
     # Equality comparison

data/lib/getstream_ruby/generated/feeds_client.rb

@@ -215,7 +215,7 @@ module GetStream
       # @param activity_id [String]
       # @param add_reaction_request [AddReactionRequest]
       # @return [Models::AddReactionResponse]
-      def add_reaction(activity_id, add_reaction_request)
+      def add_activity_reaction(activity_id, add_reaction_request)
         path = '/api/v2/feeds/activities/{activity_id}/reactions'
         # Replace path parameters
         path = path.gsub('{activity_id}', activity_id.to_s)
@@ -310,7 +310,7 @@ module GetStream
         )
       end
 
-      # Updates certain fields of the activitySends events:- feeds.activity.updated
+      # Updates certain fields of the activity. Use 'set' to update specific fields and 'unset' to remove fields. This allows you to update only the fields you need without replacing the entire activity. Useful for updating reply restrictions ('restrict_replies'), mentioned users, or custom data.Sends events:- feeds.activity.updated
       #
       # @param _id [String]
       # @param update_activity_partial_request [UpdateActivityPartialRequest]
@@ -330,7 +330,7 @@ module GetStream
         )
       end
 
-      # Replaces an activity with the provided dataSends events:- feeds.activity.updated
+      # Replaces an activity with the provided data. Use this to update text, attachments, reply restrictions ('restrict_replies'), mentioned users, and other activity fields. Note: This is a full update - any fields not provided will be cleared.Sends events:- feeds.activity.updated
       #
       # @param _id [String]
       # @param update_activity_request [UpdateActivityRequest]
@@ -420,6 +420,95 @@ module GetStream
         )
       end
 
+      # Delete collections in a batch operation. Users can only delete their own collections.
+      #
+      # @param collection_refs [Array<String>]
+      # @return [Models::DeleteCollectionsResponse]
+      def delete_collections(collection_refs)
+        path = '/api/v2/feeds/collections'
+        # Build query parameters
+        query_params = {}
+        query_params['collection_refs'] = collection_refs unless collection_refs.nil?
+
+        # Make the API request
+        @client.make_request(
+          :delete,
+          path,
+          query_params: query_params
+        )
+      end
+
+      # Read collections with optional filtering by user ID and collection name. By default, users can only read their own collections.
+      #
+      # @param collection_refs [Array<String>]
+      # @param user_id [String]
+      # @return [Models::ReadCollectionsResponse]
+      def read_collections(collection_refs, user_id = nil)
+        path = '/api/v2/feeds/collections'
+        # Build query parameters
+        query_params = {}
+        query_params['collection_refs'] = collection_refs unless collection_refs.nil?
+        query_params['user_id'] = user_id unless user_id.nil?
+
+        # Make the API request
+        @client.make_request(
+          :get,
+          path,
+          query_params: query_params
+        )
+      end
+
+      # Update existing collections in a batch operation. Only the custom data field is updatable. Users can only update their own collections.
+      #
+      # @param update_collections_request [UpdateCollectionsRequest]
+      # @return [Models::UpdateCollectionsResponse]
+      def update_collections(update_collections_request)
+        path = '/api/v2/feeds/collections'
+        # Build request body
+        body = update_collections_request
+
+        # Make the API request
+        @client.make_request(
+          :patch,
+          path,
+          body: body
+        )
+      end
+
+      # Create new collections in a batch operation. Collections are data objects that can be attached to activities for managing shared data across multiple activities.
+      #
+      # @param create_collections_request [CreateCollectionsRequest]
+      # @return [Models::CreateCollectionsResponse]
+      def create_collections(create_collections_request)
+        path = '/api/v2/feeds/collections'
+        # Build request body
+        body = create_collections_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
+      # Insert new collections or update existing ones in a batch operation. Only the custom data field is updatable for existing collections.
+      #
+      # @param upsert_collections_request [UpsertCollectionsRequest]
+      # @return [Models::UpsertCollectionsResponse]
+      def upsert_collections(upsert_collections_request)
+        path = '/api/v2/feeds/collections'
+        # Build request body
+        body = upsert_collections_request
+
+        # Make the API request
+        @client.make_request(
+          :put,
+          path,
+          body: body
+        )
+      end
+
       # Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination
       #
       # @param object_id [String]
@@ -656,14 +745,19 @@ module GetStream
 
       # List all feed groups for the application
       #
+      # @param include_soft_deleted [Boolean]
       # @return [Models::ListFeedGroupsResponse]
-      def list_feed_groups()
+      def list_feed_groups(include_soft_deleted = nil)
         path = '/api/v2/feeds/feed_groups'
+        # Build query parameters
+        query_params = {}
+        query_params['include_soft_deleted'] = include_soft_deleted unless include_soft_deleted.nil?
 
         # Make the API request
         @client.make_request(
           :get,
-          path
+          path,
+          query_params: query_params
         )
       end
 
@@ -957,16 +1051,21 @@ module GetStream
       # Get a feed group by ID
       #
       # @param _id [String]
+      # @param include_soft_deleted [Boolean]
       # @return [Models::GetFeedGroupResponse]
-      def get_feed_group(_id)
+      def get_feed_group(_id, include_soft_deleted = nil)
         path = '/api/v2/feeds/feed_groups/{id}'
         # Replace path parameters
         path = path.gsub('{id}', _id.to_s)
+        # Build query parameters
+        query_params = {}
+        query_params['include_soft_deleted'] = include_soft_deleted unless include_soft_deleted.nil?
 
         # Make the API request
         @client.make_request(
           :get,
-          path
+          path,
+          query_params: query_params
         )
       end
 
@@ -1141,6 +1240,26 @@ module GetStream
         )
       end
 
+      # Updates an existing predefined feed visibility configuration
+      #
+      # @param name [String]
+      # @param update_feed_visibility_request [UpdateFeedVisibilityRequest]
+      # @return [Models::UpdateFeedVisibilityResponse]
+      def update_feed_visibility(name, update_feed_visibility_request)
+        path = '/api/v2/feeds/feed_visibilities/{name}'
+        # Replace path parameters
+        path = path.gsub('{name}', name.to_s)
+        # Build request body
+        body = update_feed_visibility_request
+
+        # Make the API request
+        @client.make_request(
+          :put,
+          path,
+          body: body
+        )
+      end
+
       # Create multiple feeds at once for a given feed group
       #
       # @param create_feeds_batch_request [CreateFeedsBatchRequest]
@@ -1158,6 +1277,40 @@ module GetStream
         )
       end
 
+      # Delete multiple feeds by their IDs. All feeds must exist. This endpoint is server-side only.
+      #
+      # @param delete_feeds_batch_request [DeleteFeedsBatchRequest]
+      # @return [Models::DeleteFeedsBatchResponse]
+      def delete_feeds_batch(delete_feeds_batch_request)
+        path = '/api/v2/feeds/feeds/delete'
+        # Build request body
+        body = delete_feeds_batch_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
+      # Retrieves own_follows, own_capabilities, and/or own_membership for multiple feeds in a single request. If fields are not specified, all three fields are returned.
+      #
+      # @param own_batch_request [OwnBatchRequest]
+      # @return [Models::OwnBatchResponse]
+      def own_batch(own_batch_request)
+        path = '/api/v2/feeds/feeds/own/batch'
+        # Build request body
+        body = own_batch_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
       # Query feeds with filter query
       #
       # @param query_feeds_request [QueryFeedsRequest]
@@ -1175,6 +1328,32 @@ module GetStream
         )
       end
 
+      # Retrieve current rate limit status for feeds operations.Returns information about limits, usage, and remaining quota for various feed operations.
+      #
+      # @param endpoints [String]
+      # @param android [Boolean]
+      # @param ios [Boolean]
+      # @param web [Boolean]
+      # @param server_side [Boolean]
+      # @return [Models::GetFeedsRateLimitsResponse]
+      def get_feeds_rate_limits(endpoints = nil, android = nil, ios = nil, web = nil, server_side = nil)
+        path = '/api/v2/feeds/feeds/rate_limits'
+        # Build query parameters
+        query_params = {}
+        query_params['endpoints'] = endpoints unless endpoints.nil?
+        query_params['android'] = android unless android.nil?
+        query_params['ios'] = ios unless ios.nil?
+        query_params['web'] = web unless web.nil?
+        query_params['server_side'] = server_side unless server_side.nil?
+
+        # Make the API request
+        @client.make_request(
+          :get,
+          path,
+          query_params: query_params
+        )
+      end
+
       # Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Follower role can only be updated via server-side requests.
       #
       # @param update_follow_request [UpdateFollowRequest]
@@ -1243,6 +1422,23 @@ module GetStream
         )
       end
 
+      # Creates or updates multiple follows at once. Does not return an error if follows already exist. Broadcasts FollowAddedEvent only for newly created follows.
+      #
+      # @param follow_batch_request [FollowBatchRequest]
+      # @return [Models::FollowBatchResponse]
+      def get_or_create_follows(follow_batch_request)
+        path = '/api/v2/feeds/follows/batch/upsert'
+        # Build request body
+        body = follow_batch_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
       # Query follows based on filters with pagination and sorting options
       #
       # @param query_follows_request [QueryFollowsRequest]
@@ -1365,6 +1561,23 @@ module GetStream
         )
       end
 
+      # Retrieve usage statistics for feeds including activity count, follow count, and API request count.Returns data aggregated by day with pagination support via from/to date parameters.This endpoint is server-side only.
+      #
+      # @param query_feeds_usage_stats_request [QueryFeedsUsageStatsRequest]
+      # @return [Models::QueryFeedsUsageStatsResponse]
+      def query_feeds_usage_stats(query_feeds_usage_stats_request)
+        path = '/api/v2/feeds/stats/usage'
+        # Build request body
+        body = query_feeds_usage_stats_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
       # Removes multiple follows at once and broadcasts FollowRemovedEvent for each one
       #
       # @param unfollow_batch_request [UnfollowBatchRequest]
@@ -1382,23 +1595,44 @@ module GetStream
         )
       end
 
-      # Delete all activities, reactions, comments, and bookmarks for a user
+      # Removes multiple follows and broadcasts FollowRemovedEvent for each. Does not return an error if follows don't exist.
+      #
+      # @param unfollow_batch_request [UnfollowBatchRequest]
+      # @return [Models::UnfollowBatchResponse]
+      def get_or_create_unfollows(unfollow_batch_request)
+        path = '/api/v2/feeds/unfollow/batch/upsert'
+        # Build request body
+        body = unfollow_batch_request
+
+        # Make the API request
+        @client.make_request(
+          :post,
+          path,
+          body: body
+        )
+      end
+
+      # Delete all feed data for a user including: feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the user
       #
       # @param user_id [String]
+      # @param delete_feed_user_data_request [DeleteFeedUserDataRequest]
       # @return [Models::DeleteFeedUserDataResponse]
-      def delete_feed_user_data(user_id)
+      def delete_feed_user_data(user_id, delete_feed_user_data_request)
         path = '/api/v2/feeds/users/{user_id}/delete'
         # Replace path parameters
         path = path.gsub('{user_id}', user_id.to_s)
+        # Build request body
+        body = delete_feed_user_data_request
 
         # Make the API request
         @client.make_request(
-          :delete,
-          path
+          :post,
+          path,
+          body: body
         )
       end
 
-      # Export all activities, reactions, comments, and bookmarks for a user
+      # Export all feed data for a user including: user profile, feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the user
       #
       # @param user_id [String]
       # @return [Models::ExportFeedUserDataResponse]

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

@@ -19,7 +19,7 @@ module GetStream
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
-          @user_id = attributes[:user_id] || attributes['user_id'] || ""
+          @user_id = attributes[:user_id] || attributes['user_id'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end
 

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

@@ -24,7 +24,7 @@ module GetStream
           super(attributes)
           @source = attributes[:source] || attributes['source']
           @target = attributes[:target] || attributes['target']
-          @follower_role = attributes[:follower_role] || attributes['follower_role'] || ""
+          @follower_role = attributes[:follower_role] || attributes['follower_role'] || nil
         end
 
         # Override field mappings for JSON serialization

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

@@ -31,8 +31,8 @@ module GetStream
           @name = attributes[:name] || attributes['name']
           @text = attributes[:text] || attributes['text']
           @type = attributes[:type] || attributes['type']
-          @style = attributes[:style] || attributes['style'] || ""
-          @value = attributes[:value] || attributes['value'] || ""
+          @style = attributes[:style] || attributes['style'] || nil
+          @value = attributes[:value] || attributes['value'] || nil
         end
 
         # Override field mappings for JSON serialization

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

@@ -27,6 +27,9 @@ module GetStream
         # @!attribute user_id
         #   @return [String] ID of the user who performed the action
         attr_accessor :user_id
+        # @!attribute ai_providers
+        #   @return [Array<String>]
+        attr_accessor :ai_providers
         # @!attribute custom
         #   @return [Object] Additional metadata about the action
         attr_accessor :custom
@@ -49,6 +52,7 @@ module GetStream
           @target_user_id = attributes[:target_user_id] || attributes['target_user_id']
           @type = attributes[:type] || attributes['type']
           @user_id = attributes[:user_id] || attributes['user_id']
+          @ai_providers = attributes[:ai_providers] || attributes['ai_providers']
           @custom = attributes[:custom] || attributes['custom']
           @review_queue_item = attributes[:review_queue_item] || attributes['review_queue_item'] || nil
           @target_user = attributes[:target_user] || attributes['target_user'] || nil
@@ -64,6 +68,7 @@ module GetStream
             target_user_id: 'target_user_id',
             type: 'type',
             user_id: 'user_id',
+            ai_providers: 'ai_providers',
             custom: 'custom',
             review_queue_item: 'review_queue_item',
             target_user: 'target_user',

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

@@ -34,13 +34,13 @@ module GetStream
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
-          @action = attributes[:action] || attributes['action'] || ""
-          @blur = attributes[:blur] || attributes['blur'] || false
-          @cooldown_period = attributes[:cooldown_period] || attributes['cooldown_period'] || 0
-          @threshold = attributes[:threshold] || attributes['threshold'] || 0
-          @time_window = attributes[:time_window] || attributes['time_window'] || 0
-          @warning = attributes[:warning] || attributes['warning'] || false
-          @warning_text = attributes[:warning_text] || attributes['warning_text'] || ""
+          @action = attributes[:action] || attributes['action'] || nil
+          @blur = attributes[:blur] || attributes['blur'] || nil
+          @cooldown_period = attributes[:cooldown_period] || attributes['cooldown_period'] || nil
+          @threshold = attributes[:threshold] || attributes['threshold'] || nil
+          @time_window = attributes[:time_window] || attributes['time_window'] || nil
+          @warning = attributes[:warning] || attributes['warning'] || nil
+          @warning_text = attributes[:warning_text] || attributes['warning_text'] || nil
         end
 
         # Override field mappings for JSON serialization

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

@@ -42,7 +42,7 @@ module GetStream
           @activity = attributes[:activity] || attributes['activity']
           @custom = attributes[:custom] || attributes['custom']
           @type = attributes[:type] || attributes['type'] || "feeds.activity.added"
-          @feed_visibility = attributes[:feed_visibility] || attributes['feed_visibility'] || ""
+          @feed_visibility = attributes[:feed_visibility] || attributes['feed_visibility'] || nil
           @received_at = attributes[:received_at] || attributes['received_at'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end

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

@@ -42,7 +42,7 @@ module GetStream
           @activity = attributes[:activity] || attributes['activity']
           @custom = attributes[:custom] || attributes['custom']
           @type = attributes[:type] || attributes['type'] || "feeds.activity.deleted"
-          @feed_visibility = attributes[:feed_visibility] || attributes['feed_visibility'] || ""
+          @feed_visibility = attributes[:feed_visibility] || attributes['feed_visibility'] || nil
           @received_at = attributes[:received_at] || attributes['received_at'] || nil
           @user = attributes[:user] || attributes['user'] || nil
         end

data/lib/getstream_ruby/generated/models/activity_feedback_event.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
+      # Emitted when activity feedback is provided.
+      class ActivityFeedbackEvent < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute created_at
+        #   @return [DateTime] Date/time of creation
+        attr_accessor :created_at
+        # @!attribute activity_feedback
+        #   @return [ActivityFeedbackEventPayload]
+        attr_accessor :activity_feedback
+        # @!attribute custom
+        #   @return [Object]
+        attr_accessor :custom
+        # @!attribute type
+        #   @return [String] The type of event: "feeds.activity.feedback" in this case
+        attr_accessor :type
+        # @!attribute received_at
+        #   @return [DateTime]
+        attr_accessor :received_at
+        # @!attribute user
+        #   @return [UserResponseCommonFields]
+        attr_accessor :user
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @created_at = attributes[:created_at] || attributes['created_at']
+          @activity_feedback = attributes[:activity_feedback] || attributes['activity_feedback']
+          @custom = attributes[:custom] || attributes['custom']
+          @type = attributes[:type] || attributes['type'] || "feeds.activity.feedback"
+          @received_at = attributes[:received_at] || attributes['received_at'] || nil
+          @user = attributes[:user] || attributes['user'] || nil
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            created_at: 'created_at',
+            activity_feedback: 'activity_feedback',
+            custom: 'custom',
+            type: 'type',
+            received_at: 'received_at',
+            user: 'user'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/getstream_ruby/generated/models/activity_feedback_event_payload.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 ActivityFeedbackEventPayload < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute action
+        #   @return [String] The type of feedback action
+        attr_accessor :action
+        # @!attribute activity_id
+        #   @return [String] The activity that received feedback
+        attr_accessor :activity_id
+        # @!attribute created_at
+        #   @return [DateTime] When the feedback was created
+        attr_accessor :created_at
+        # @!attribute updated_at
+        #   @return [DateTime] When the feedback was last updated
+        attr_accessor :updated_at
+        # @!attribute value
+        #   @return [String] The feedback value (true/false)
+        attr_accessor :value
+        # @!attribute user
+        #   @return [UserResponse]
+        attr_accessor :user
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @action = attributes[:action] || attributes['action']
+          @activity_id = attributes[:activity_id] || attributes['activity_id']
+          @created_at = attributes[:created_at] || attributes['created_at']
+          @updated_at = attributes[:updated_at] || attributes['updated_at']
+          @value = attributes[:value] || attributes['value']
+          @user = attributes[:user] || attributes['user']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            action: 'action',
+            activity_id: 'activity_id',
+            created_at: 'created_at',
+            updated_at: 'updated_at',
+            value: 'value',
+            user: 'user'
+          }
+        end
+      end
+    end
+  end
+end