getstream-ruby 6.1.1 → 7.1.0

data/lib/getstream_ruby/errors.rb

@@ -2,8 +2,112 @@
 
 module GetStreamRuby
 
-  class Error < StandardError; end
-  class ConfigurationError < Error; end
-  class APIError < Error; end
+  # Base error class for the SDK. Every SDK-raised exception is a subclass.
+  class StreamError < StandardError; end
+
+  # Back-compat alias. The prior base class was `Error`; keep it usable so
+  # any existing `rescue GetStreamRuby::Error` clauses keep matching.
+  Error = StreamError
+
+  class ConfigurationError < StreamError; end
+
+  # Raised on any HTTP 4xx/5xx response. Also raised when an HTTP response is
+  # received but its body is not a parseable `APIError` envelope, with `code = 0`
+  # and `message = "failed to parse error response"`.
+  class ApiError < StreamError
+
+    attr_reader :status_code, :code, :exception_fields, :unrecoverable,
+                :raw_response_body, :more_info, :details
+
+    def initialize(message:, status_code:, code:, exception_fields: nil,
+                   unrecoverable: nil, raw_response_body: nil,
+                   more_info: nil, details: nil)
+      super(message)
+      @status_code = status_code
+      @code = code
+      @exception_fields = exception_fields || {}
+      @unrecoverable = unrecoverable.nil? ? false : unrecoverable
+      @raw_response_body = raw_response_body || ''
+      @more_info = more_info
+      @details = details
+    end
+
+  end
+
+  # Raised on HTTP 429. Adds parsed `Retry-After` as Float seconds, or nil when
+  # the header is absent or unparseable. Per RFC 7231, both integer-seconds and
+  # HTTP-date forms are supported. Past HTTP-dates clamp to 0.
+  class RateLimitError < ApiError
+
+    attr_reader :retry_after
+
+    def initialize(retry_after: nil, **kwargs)
+      super(**kwargs)
+      @retry_after = retry_after
+    end
+
+  end
+
+  # Allowed values for `TransportError#error_type`.
+  TRANSPORT_ERROR_TYPES = %w[
+    connection_reset
+    timeout
+    dns_failure
+    tls_handshake_failed
+    unknown
+  ].freeze
+
+  # Raised when no HTTP response is received: connection reset, timeout, TLS
+  # handshake failure, DNS failure. Always raised inside the matching `rescue`
+  # block so Ruby auto-sets `Exception#cause` to the underlying Faraday error.
+  class TransportError < StreamError
+
+    attr_reader :error_type
+
+    def initialize(message = nil, error_type: 'unknown')
+      super(message)
+      @error_type = error_type
+    end
+
+  end
+
+  # Raised by `Client#wait_for_task` when an async task finishes with
+  # status="failed". Carries the populated `ErrorResult` fields.
+  class TaskError < StreamError
+
+    attr_reader :task_id, :error_type, :description, :stack_trace, :version
+
+    def initialize(task_id:, error_type:, description:,
+                   stack_trace: nil, version: nil)
+      super(description)
+      @task_id = task_id
+      @error_type = error_type
+      @description = description
+      @stack_trace = stack_trace
+      @version = version
+    end
+
+  end
+
+  # Deprecated alias for ApiError. Will be removed in v9.0.
+  # Implemented via `const_missing` so the first access emits a `Kernel.warn`
+  # once-only and the constant is cached afterwards (no per-rescue noise).
+  @apierror_alias_warned = false
+
+  def self.const_missing(name)
+    if name == :APIError
+      unless @apierror_alias_warned
+        Kernel.warn(
+          '[DEPRECATION] GetStreamRuby::APIError is renamed to ' \
+          'GetStreamRuby::ApiError. The old constant will be removed in v9.0.',
+        )
+        @apierror_alias_warned = true
+      end
+      const_set(:APIError, ApiError)
+      ApiError
+    else
+      super
+    end
+  end
 
 end

data/lib/getstream_ruby/generated/common_client.rb

@@ -981,6 +981,32 @@ module GetStream
         )
       end
 
+      # Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocomplete
+      #
+      # @param query [String]
+      # @param limit [Integer]
+      # @param name_gt [String]
+      # @param role_type [String]
+      # @param include_global_roles [Boolean]
+      # @return [Models::SearchRolesResponse]
+      def search_roles(query, limit = nil, name_gt = nil, role_type = nil, include_global_roles = nil)
+        path = '/api/v2/roles/search'
+        # Build query parameters
+        query_params = {}
+        query_params['query'] = query unless query.nil?
+        query_params['limit'] = limit unless limit.nil?
+        query_params['name_gt'] = name_gt unless name_gt.nil?
+        query_params['role_type'] = role_type unless role_type.nil?
+        query_params['include_global_roles'] = include_global_roles unless include_global_roles.nil?
+
+        # Make the API request
+        @client.make_request(
+          :get,
+          path,
+          query_params: query_params
+        )
+      end
+
       # Deletes custom role
       #
       # @param name [String]

data/lib/getstream_ruby/generated/feed.rb

@@ -17,11 +17,13 @@ module GetStream
       # Delete a single feed by its ID
       #
       # @param hard_delete [Boolean]
+      # @param purge_user_activities [Boolean]
       # @return [Models::DeleteFeedResponse]
-      def delete_feed(hard_delete = nil)
+      def delete_feed(hard_delete = nil, purge_user_activities = nil)
         # Build query parameters
         query_params = {}
         query_params['hard_delete'] = hard_delete unless hard_delete.nil?
+        query_params['purge_user_activities'] = purge_user_activities unless purge_user_activities.nil?
 
         # Delegate to the FeedsClient
         @client.feeds.delete_feed(@feed_group_id, @feed_id, query_params)

data/lib/getstream_ruby/generated/feeds_client.rb

@@ -992,8 +992,9 @@ module GetStream
       # @param feed_group_id [String]
       # @param feed_id [String]
       # @param hard_delete [Boolean]
+      # @param purge_user_activities [Boolean]
       # @return [Models::DeleteFeedResponse]
-      def delete_feed(feed_group_id, feed_id, hard_delete = nil)
+      def delete_feed(feed_group_id, feed_id, hard_delete = nil, purge_user_activities = nil)
         path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}'
         # Replace path parameters
         path = path.gsub('{feed_group_id}', feed_group_id.to_s)
@@ -1001,6 +1002,7 @@ module GetStream
         # Build query parameters
         query_params = {}
         query_params['hard_delete'] = hard_delete unless hard_delete.nil?
+        query_params['purge_user_activities'] = purge_user_activities unless purge_user_activities.nil?
 
         # Make the API request
         @client.make_request(

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

@@ -43,7 +43,7 @@ module GetStream
           @started_at = attributes[:started_at] || attributes['started_at']
           @task_id = attributes[:task_id] || attributes['task_id']
           @custom = attributes[:custom] || attributes['custom']
-          @type = attributes[:type] || attributes['type'] || "export.users.error"
+          @type = attributes[:type] || attributes['type'] || "export.bulk_image_moderation.error"
           @received_at = attributes[:received_at] || attributes['received_at'] || nil
         end
 

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

@@ -15,19 +15,24 @@ module GetStream
         # @!attribute hard_delete
         #   @return [Boolean] Whether to permanently delete the feeds instead of soft delete
         attr_accessor :hard_delete
+        # @!attribute purge_user_activities
+        #   @return [Boolean] When hard-deleting, also fully delete activities authored by each feed's owner from every other feed those activities were fanned out to. Default false preserves existing fan-out. Requires 'hard_delete' to be true; the request is rejected otherwise. Feeds with no recorded owner (created_by_id is empty) are silently skipped for the purge step — owner-matching against an empty string is a safety guard, not a wildcard.
+        attr_accessor :purge_user_activities
 
         # Initialize with attributes
         def initialize(attributes = {})
           super(attributes)
           @feeds = attributes[:feeds] || attributes['feeds']
           @hard_delete = attributes[:hard_delete] || attributes['hard_delete'] || nil
+          @purge_user_activities = attributes[:purge_user_activities] || attributes['purge_user_activities'] || nil
         end
 
         # Override field mappings for JSON serialization
         def self.json_field_mappings
           {
             feeds: 'feeds',
-            hard_delete: 'hard_delete'
+            hard_delete: 'hard_delete',
+            purge_user_activities: 'purge_user_activities'
           }
         end
       end

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

@@ -21,6 +21,9 @@ module GetStream
         # @!attribute content_type
         #   @return [String] Type of content: 'text' (default), 'message', or 'username'. Stored as-sent; only 'username' routes to the username moderation API.
         attr_accessor :content_type
+        # @!attribute dry_run
+        #   @return [Boolean] When true, run moderation and return labels without persisting the result. Useful for one-off checks (e.g. UI testers) that should not be recorded in the stored history.
+        attr_accessor :dry_run
         # @!attribute policy
         #   @return [String] Optional moderation policy key (max 128 chars)
         attr_accessor :policy
@@ -35,6 +38,7 @@ module GetStream
           @category = attributes[:category] || attributes['category'] || nil
           @content_id = attributes[:content_id] || attributes['content_id'] || nil
           @content_type = attributes[:content_type] || attributes['content_type'] || nil
+          @dry_run = attributes[:dry_run] || attributes['dry_run'] || nil
           @policy = attributes[:policy] || attributes['policy'] || nil
           @user_id = attributes[:user_id] || attributes['user_id'] || nil
         end
@@ -46,6 +50,7 @@ module GetStream
             category: 'category',
             content_id: 'content_id',
             content_type: 'content_type',
+            dry_run: 'dry_run',
             policy: 'policy',
             user_id: 'user_id'
           }

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

@@ -21,12 +21,18 @@ module GetStream
         # @!attribute prev
         #   @return [String]
         attr_accessor :prev
+        # @!attribute user_id
+        #   @return [String]
+        attr_accessor :user_id
         # @!attribute sort
         #   @return [Array<SortParamRequest>] Sorting parameters for the query
         attr_accessor :sort
         # @!attribute filter
         #   @return [Object] Filters to apply to the query
         attr_accessor :filter
+        # @!attribute user
+        #   @return [UserRequest]
+        attr_accessor :user
 
         # Initialize with attributes
         def initialize(attributes = {})
@@ -35,8 +41,10 @@ module GetStream
           @limit = attributes[:limit] || attributes['limit'] || nil
           @next = attributes[:next] || attributes['next'] || nil
           @prev = attributes[:prev] || attributes['prev'] || nil
+          @user_id = attributes[:user_id] || attributes['user_id'] || nil
           @sort = attributes[:sort] || attributes['sort'] || nil
           @filter = attributes[:filter] || attributes['filter'] || nil
+          @user = attributes[:user] || attributes['user'] || nil
         end
 
         # Override field mappings for JSON serialization
@@ -46,8 +54,10 @@ module GetStream
             limit: 'limit',
             next: 'next',
             prev: 'prev',
+            user_id: 'user_id',
             sort: 'sort',
-            filter: 'filter'
+            filter: 'filter',
+            user: 'user'
           }
         end
       end

data/lib/getstream_ruby/generated/models/search_roles_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 SearchRolesResponse < GetStream::BaseModel
+
+        # Model attributes
+        # @!attribute duration
+        #   @return [String]
+        attr_accessor :duration
+        # @!attribute roles
+        #   @return [Array<Role>] Matching roles, sorted ascending by name
+        attr_accessor :roles
+
+        # Initialize with attributes
+        def initialize(attributes = {})
+          super(attributes)
+          @duration = attributes[:duration] || attributes['duration']
+          @roles = attributes[:roles] || attributes['roles']
+        end
+
+        # Override field mappings for JSON serialization
+        def self.json_field_mappings
+          {
+            duration: 'duration',
+            roles: 'roles'
+          }
+        end
+      end
+    end
+  end
+end