cadenya 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f866d6d239caac71a8e80827e7318e297c1d339fdaee6e59c6cf8cee057fd3
-  data.tar.gz: d1361f3fe5c8480be71bdfa73937602bc8d9b56fc444e9b197efd213b928f4eb
+  metadata.gz: 56345beed04805e02e3d9160438370098e235277a458b4d99964df96d689d1fa
+  data.tar.gz: 48e4a95347381ea29f7f4523d1098af4aab96e1a9a43e5187a6c115120848087
 SHA512:
-  metadata.gz: 05b854a43d809324ee5a1b7460c7e48aa4c03f9d98a03001702a64a48f28f26b78d2e60024929f3eba0b99715967d6c33c15c64910b7e166afb5de866c98d327
-  data.tar.gz: 62f17cdbb96038ac3b959d69ad67d5de66b715d69f2ed6f4fa83b979d9c6b3d61dcb0433607284ea900baabd27fdbacbc38081d8710729a8ae689e9d7c14a875
+  metadata.gz: 9e343691120327cdd8c6c1d14df4f15d77344f9a625ec59fff2d743999330aacecb0fad0fe0290ebd8bd2094bce006b60e95e225ef4c1f403700542bfe03feff
+  data.tar.gz: 218de860735ffcfcc65da64a9ca06675bfee2a54f45c5588ec400e5d330d9cedd7e9730a3078592ad4924d4698a291c2a26fe0baf79f181bbdc527c6b58d540b

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.24.0 (2026-07-01)
+
+Full Changelog: [v0.23.0...v0.24.0](https://github.com/cadenya/cadenya-ruby/compare/v0.23.0...v0.24.0)
+
+### Features
+
+* **api:** api update ([2dc6e63](https://github.com/cadenya/cadenya-ruby/commit/2dc6e631c0c63392b148ea3458ce560593bcf27a))
+
+## 0.23.0 (2026-07-01)
+
+Full Changelog: [v0.22.0...v0.23.0](https://github.com/cadenya/cadenya-ruby/compare/v0.22.0...v0.23.0)
+
+### Features
+
+* Add SSE streaming endpoint for objective events (ENG-344) ([eec699b](https://github.com/cadenya/cadenya-ruby/commit/eec699b38fee3662e2d07d8ca22b321472d88e93))
+* **api:** api update ([d9ebcf1](https://github.com/cadenya/cadenya-ruby/commit/d9ebcf1e47b6bb392dada1aa8e64d230ca342e42))
+
 ## 0.22.0 (2026-07-01)
 
 Full Changelog: [v0.21.0...v0.22.0](https://github.com/cadenya/cadenya-ruby/compare/v0.21.0...v0.22.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "cadenya", "~> 0.22.0"
+gem "cadenya", "~> 0.24.0"
 ```
 
 <!-- x-release-please-end -->
@@ -37,6 +37,18 @@ account = cadenya.account.retrieve
 puts(account.info)
 ```
 
+### Streaming
+
+We provide support for streaming responses using Server-Sent Events (SSE).
+
+```ruby
+stream = cadenya.objectives.stream_events_streaming
+
+stream.each do |objective|
+  puts(objective.data)
+end
+```
+
 ### Pagination
 
 List methods in the Cadenya API are paginated.

data/lib/cadenya/internal/stream.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   stream.each do |event|
+    #     puts(event)
+    #   end
+    class Stream
+      include Cadenya::Internal::Type::BaseStream
+
+      # @api private
+      #
+      # @return [Enumerable<generic<Elem>>]
+      private def iterator
+        @iterator ||= Cadenya::Internal::Util.chain_fused(@stream) do |y|
+          @stream.each do |msg|
+            case msg
+            in {data: String => data}
+              decoded = JSON.parse(data, symbolize_names: true)
+              unwrapped = Cadenya::Internal::Util.dig(decoded, @unwrap)
+              y << Cadenya::Internal::Type::Converter.coerce(@model, unwrapped)
+            else
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cadenya/internal/transport/base_client.rb

@@ -554,7 +554,7 @@ module Cadenya
                 )
               ),
               page: T.nilable(T::Class[Cadenya::Internal::Type::BasePage[Cadenya::Internal::Type::BaseModel]]),
-              stream: T.nilable(T::Class[T.anything]),
+              stream: T.nilable(T::Class[Cadenya::Internal::Type::BaseStream[T.anything, Cadenya::Internal::Type::BaseModel]]),
               model: T.nilable(Cadenya::Internal::Type::Converter::Input),
               options: T.nilable(Cadenya::RequestOptions::OrHash)
             }

data/lib/cadenya/internal/type/base_stream.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Internal
+    module Type
+      # @api private
+      #
+      # @generic Elem
+      #
+      # This module provides a base implementation for streaming responses in the SDK.
+      #
+      # @see https://rubyapi.org/3.2/o/enumerable
+      module BaseStream
+        include Enumerable
+
+        # @return [Integer]
+        attr_reader :status
+
+        # @return [Hash{String=>String}]
+        attr_reader :headers
+
+        # @api public
+        #
+        # @return [void]
+        def close = Cadenya::Internal::Util.close_fused!(@iterator)
+
+        # @api private
+        #
+        # @return [Enumerable<generic<Elem>>]
+        private def iterator = (raise NotImplementedError)
+
+        # @api public
+        #
+        # @param blk [Proc]
+        #
+        # @yieldparam [generic<Elem>]
+        # @return [void]
+        def each(&blk)
+          unless block_given?
+            raise ArgumentError.new("A block must be given to ##{__method__}")
+          end
+          @iterator.each(&blk)
+        end
+
+        # @api public
+        #
+        # @return [Enumerator<generic<Elem>>]
+        def to_enum = @iterator
+
+        alias_method :enum_for, :to_enum
+
+        # @api private
+        #
+        # @param model [Class, Cadenya::Internal::Type::Converter]
+        # @param url [URI::Generic]
+        # @param status [Integer]
+        # @param headers [Hash{String=>String}]
+        # @param response [Net::HTTPResponse]
+        # @param unwrap [Symbol, Integer, Array<Symbol, Integer>, Proc]
+        # @param stream [Enumerable<Object>]
+        def initialize(model:, url:, status:, headers:, response:, unwrap:, stream:)
+          @model = model
+          @url = url
+          @status = status
+          @headers = headers
+          @response = response
+          @unwrap = unwrap
+          @stream = stream
+          @iterator = iterator
+        end
+
+        # @api private
+        #
+        # @return [String]
+        def inspect
+          model = Cadenya::Internal::Type::Converter.inspect(@model, depth: 1)
+
+          "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+        end
+      end
+    end
+  end
+end

data/lib/cadenya/models/{objective_continue_response.rb → objective_event.rb}

@@ -3,7 +3,7 @@
 module Cadenya
   module Models
     # @see Cadenya::Resources::Objectives#continue
-    class ObjectiveContinueResponse < Cadenya::Internal::Type::BaseModel
+    class ObjectiveEvent < Cadenya::Internal::Type::BaseModel
       # @!attribute data
       #
       #   @return [Cadenya::Models::ObjectiveEventData]
@@ -28,7 +28,7 @@ module Cadenya
 
       # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Cadenya::Models::ObjectiveContinueResponse} for more details.
+      #   {Cadenya::Models::ObjectiveEvent} for more details.
       #
       #   @param data [Cadenya::Models::ObjectiveEventData]
       #

data/lib/cadenya/models/objective_event_webhook_data.rb

@@ -58,10 +58,8 @@ module Cadenya
 
         # @!attribute objective_event
         #
-        #   @return [Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent]
-        required :objective_event,
-                 -> { Cadenya::ObjectiveEventWebhookData::Data::ObjectiveEvent },
-                 api_name: :objectiveEvent
+        #   @return [Cadenya::Models::ObjectiveEvent]
+        required :objective_event, -> { Cadenya::ObjectiveEvent }, api_name: :objectiveEvent
 
         # @!method initialize(agent:, agent_variation:, objective:, objective_event:)
         #   Some parameter documentations has been truncated, see
@@ -76,45 +74,7 @@ module Cadenya
         #
         #   @param objective [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
         #
-        #   @param objective_event [Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent]
-
-        # @see Cadenya::Models::ObjectiveEventWebhookData::Data#objective_event
-        class ObjectiveEvent < Cadenya::Internal::Type::BaseModel
-          # @!attribute data
-          #
-          #   @return [Cadenya::Models::ObjectiveEventData]
-          required :data, -> { Cadenya::ObjectiveEventData }
-
-          # @!attribute metadata
-          #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #   runs)
-          #
-          #   @return [Cadenya::Models::OperationMetadata]
-          required :metadata, -> { Cadenya::OperationMetadata }
-
-          # @!attribute context_window_id
-          #
-          #   @return [String, nil]
-          optional :context_window_id, String, api_name: :contextWindowId
-
-          # @!attribute info
-          #
-          #   @return [Cadenya::Models::ObjectiveEventInfo, nil]
-          optional :info, -> { Cadenya::ObjectiveEventInfo }
-
-          # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent} for more
-          #   details.
-          #
-          #   @param data [Cadenya::Models::ObjectiveEventData]
-          #
-          #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #
-          #   @param context_window_id [String]
-          #
-          #   @param info [Cadenya::Models::ObjectiveEventInfo]
-        end
+        #   @param objective_event [Cadenya::Models::ObjectiveEvent]
       end
     end
   end

data/lib/cadenya/models/objective_stream_events_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Objectives#stream_events_streaming
+    class ObjectiveStreamEventsParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute objective_id
+      #
+      #   @return [String]
+      required :objective_id, String
+
+      # @!method initialize(workspace_id:, objective_id:, request_options: {})
+      #   @param workspace_id [String]
+      #   @param objective_id [String]
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/unsafe_unwrap_webhook_event.rb

@@ -58,10 +58,8 @@ module Cadenya
 
         # @!attribute objective_event
         #
-        #   @return [Cadenya::Models::UnsafeUnwrapWebhookEvent::Data::ObjectiveEvent]
-        required :objective_event,
-                 -> { Cadenya::UnsafeUnwrapWebhookEvent::Data::ObjectiveEvent },
-                 api_name: :objectiveEvent
+        #   @return [Cadenya::Models::ObjectiveEvent]
+        required :objective_event, -> { Cadenya::ObjectiveEvent }, api_name: :objectiveEvent
 
         # @!method initialize(agent:, agent_variation:, objective:, objective_event:)
         #   Some parameter documentations has been truncated, see
@@ -76,45 +74,7 @@ module Cadenya
         #
         #   @param objective [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
         #
-        #   @param objective_event [Cadenya::Models::UnsafeUnwrapWebhookEvent::Data::ObjectiveEvent]
-
-        # @see Cadenya::Models::UnsafeUnwrapWebhookEvent::Data#objective_event
-        class ObjectiveEvent < Cadenya::Internal::Type::BaseModel
-          # @!attribute data
-          #
-          #   @return [Cadenya::Models::ObjectiveEventData]
-          required :data, -> { Cadenya::ObjectiveEventData }
-
-          # @!attribute metadata
-          #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #   runs)
-          #
-          #   @return [Cadenya::Models::OperationMetadata]
-          required :metadata, -> { Cadenya::OperationMetadata }
-
-          # @!attribute context_window_id
-          #
-          #   @return [String, nil]
-          optional :context_window_id, String, api_name: :contextWindowId
-
-          # @!attribute info
-          #
-          #   @return [Cadenya::Models::ObjectiveEventInfo, nil]
-          optional :info, -> { Cadenya::ObjectiveEventInfo }
-
-          # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Cadenya::Models::UnsafeUnwrapWebhookEvent::Data::ObjectiveEvent} for more
-          #   details.
-          #
-          #   @param data [Cadenya::Models::ObjectiveEventData]
-          #
-          #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #
-          #   @param context_window_id [String]
-          #
-          #   @param info [Cadenya::Models::ObjectiveEventInfo]
-        end
+        #   @param objective_event [Cadenya::Models::ObjectiveEvent]
       end
     end
   end

data/lib/cadenya/models/unwrap_webhook_event.rb

@@ -58,10 +58,8 @@ module Cadenya
 
         # @!attribute objective_event
         #
-        #   @return [Cadenya::Models::UnwrapWebhookEvent::Data::ObjectiveEvent]
-        required :objective_event,
-                 -> { Cadenya::UnwrapWebhookEvent::Data::ObjectiveEvent },
-                 api_name: :objectiveEvent
+        #   @return [Cadenya::Models::ObjectiveEvent]
+        required :objective_event, -> { Cadenya::ObjectiveEvent }, api_name: :objectiveEvent
 
         # @!method initialize(agent:, agent_variation:, objective:, objective_event:)
         #   Some parameter documentations has been truncated, see
@@ -76,44 +74,7 @@ module Cadenya
         #
         #   @param objective [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
         #
-        #   @param objective_event [Cadenya::Models::UnwrapWebhookEvent::Data::ObjectiveEvent]
-
-        # @see Cadenya::Models::UnwrapWebhookEvent::Data#objective_event
-        class ObjectiveEvent < Cadenya::Internal::Type::BaseModel
-          # @!attribute data
-          #
-          #   @return [Cadenya::Models::ObjectiveEventData]
-          required :data, -> { Cadenya::ObjectiveEventData }
-
-          # @!attribute metadata
-          #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #   runs)
-          #
-          #   @return [Cadenya::Models::OperationMetadata]
-          required :metadata, -> { Cadenya::OperationMetadata }
-
-          # @!attribute context_window_id
-          #
-          #   @return [String, nil]
-          optional :context_window_id, String, api_name: :contextWindowId
-
-          # @!attribute info
-          #
-          #   @return [Cadenya::Models::ObjectiveEventInfo, nil]
-          optional :info, -> { Cadenya::ObjectiveEventInfo }
-
-          # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Cadenya::Models::UnwrapWebhookEvent::Data::ObjectiveEvent} for more details.
-          #
-          #   @param data [Cadenya::Models::ObjectiveEventData]
-          #
-          #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
-          #
-          #   @param context_window_id [String]
-          #
-          #   @param info [Cadenya::Models::ObjectiveEventInfo]
-        end
+        #   @param objective_event [Cadenya::Models::ObjectiveEvent]
       end
     end
   end

data/lib/cadenya/models.rb

@@ -183,6 +183,8 @@ module Cadenya
 
   ObjectiveError = Cadenya::Models::ObjectiveError
 
+  ObjectiveEvent = Cadenya::Models::ObjectiveEvent
+
   ObjectiveEventData = Cadenya::Models::ObjectiveEventData
 
   ObjectiveEventInfo = Cadenya::Models::ObjectiveEventInfo
@@ -203,6 +205,8 @@ module Cadenya
 
   ObjectiveSecret = Cadenya::Models::ObjectiveSecret
 
+  ObjectiveStreamEventsParams = Cadenya::Models::ObjectiveStreamEventsParams
+
   OperationMetadata = Cadenya::Models::OperationMetadata
 
   Page = Cadenya::Models::Page

data/lib/cadenya/resources/objectives.rb

@@ -222,7 +222,7 @@ module Cadenya
       #
       # @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Cadenya::Models::ObjectiveContinueResponse]
+      # @return [Cadenya::Models::ObjectiveEvent]
       #
       # @see Cadenya::Models::ObjectiveContinueParams
       def continue(objective_id, params)
@@ -235,7 +235,7 @@ module Cadenya
           method: :post,
           path: ["v1/workspaces/%1$s/objectives/%2$s:continue", workspace_id, objective_id],
           body: parsed,
-          model: Cadenya::Models::ObjectiveContinueResponse,
+          model: Cadenya::ObjectiveEvent,
           options: options
         )
       end
@@ -299,7 +299,7 @@ module Cadenya
       #
       # @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Cadenya::Internal::CursorPagination<Cadenya::Models::ObjectiveListEventsResponse>]
+      # @return [Cadenya::Internal::CursorPagination<Cadenya::Models::ObjectiveEvent>]
       #
       # @see Cadenya::Models::ObjectiveListEventsParams
       def list_events(objective_id, params)
@@ -319,7 +319,34 @@ module Cadenya
             window_id: "windowId"
           ),
           page: Cadenya::Internal::CursorPagination,
-          model: Cadenya::Models::ObjectiveListEventsResponse,
+          model: Cadenya::ObjectiveEvent,
+          options: options
+        )
+      end
+
+      # Streams events for an objective in real-time using server-sent events (SSE)
+      #
+      # @overload stream_events_streaming(objective_id, workspace_id:, request_options: {})
+      #
+      # @param objective_id [String]
+      # @param workspace_id [String]
+      # @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Cadenya::Internal::Stream<Cadenya::Models::ObjectiveEvent>]
+      #
+      # @see Cadenya::Models::ObjectiveStreamEventsParams
+      def stream_events_streaming(objective_id, params)
+        parsed, options = Cadenya::ObjectiveStreamEventsParams.dump_request(params)
+        workspace_id =
+          parsed.delete(:workspace_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["v1/workspaces/%1$s/objectives/%2$s/events:stream", workspace_id, objective_id],
+          headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
+          stream: Cadenya::Internal::Stream,
+          model: Cadenya::ObjectiveEvent,
           options: options
         )
       end

data/lib/cadenya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cadenya
-  VERSION = "0.22.0"
+  VERSION = "0.24.0"
 end

data/lib/cadenya.rb

@@ -45,6 +45,7 @@ require_relative "cadenya/internal/type/array_of"
 require_relative "cadenya/internal/type/hash_of"
 require_relative "cadenya/internal/type/base_model"
 require_relative "cadenya/internal/type/base_page"
+require_relative "cadenya/internal/type/base_stream"
 require_relative "cadenya/internal/type/request_parameters"
 require_relative "cadenya/internal"
 require_relative "cadenya/request_options"
@@ -53,6 +54,7 @@ require_relative "cadenya/errors"
 require_relative "cadenya/internal/transport/base_client"
 require_relative "cadenya/internal/transport/pooled_net_requester"
 require_relative "cadenya/client"
+require_relative "cadenya/internal/stream"
 require_relative "cadenya/internal/cursor_pagination"
 require_relative "cadenya/models/account"
 require_relative "cadenya/models/account_info"
@@ -177,16 +179,15 @@ require_relative "cadenya/models/objective_config_snapshot"
 require_relative "cadenya/models/objective_context_window"
 require_relative "cadenya/models/objective_context_window_data"
 require_relative "cadenya/models/objective_continue_params"
-require_relative "cadenya/models/objective_continue_response"
 require_relative "cadenya/models/objective_create_params"
 require_relative "cadenya/models/objective_error"
+require_relative "cadenya/models/objective_event"
 require_relative "cadenya/models/objective_event_data"
 require_relative "cadenya/models/objective_event_info"
 require_relative "cadenya/models/objective_event_webhook_data"
 require_relative "cadenya/models/objective_info"
 require_relative "cadenya/models/objective_list_context_windows_params"
 require_relative "cadenya/models/objective_list_events_params"
-require_relative "cadenya/models/objective_list_events_response"
 require_relative "cadenya/models/objective_list_params"
 require_relative "cadenya/models/objective_retrieve_params"
 require_relative "cadenya/models/objectives/feedback_create_params"
@@ -215,6 +216,7 @@ require_relative "cadenya/models/objectives/tool_call_list_params"
 require_relative "cadenya/models/objectives/tool_call_retrieve_params"
 require_relative "cadenya/models/objectives/tool_list_params"
 require_relative "cadenya/models/objective_secret"
+require_relative "cadenya/models/objective_stream_events_params"
 require_relative "cadenya/models/operation_metadata"
 require_relative "cadenya/models/page"
 require_relative "cadenya/models/profile"

data/rbi/cadenya/internal/stream.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Cadenya
+  module Internal
+    class Stream
+      Message =
+        type_member(:in) { { fixed: Cadenya::Internal::Util::ServerSentEvent } }
+      Elem = type_member(:out)
+
+      include Cadenya::Internal::Type::BaseStream
+
+      # @api private
+      sig { override.returns(T::Enumerable[Elem]) }
+      private def iterator
+      end
+    end
+  end
+end

data/rbi/cadenya/internal/transport/base_client.rbi

@@ -49,7 +49,15 @@ module Cadenya
                     ]
                   ]
                 ),
-              stream: T.nilable(T::Class[T.anything]),
+              stream:
+                T.nilable(
+                  T::Class[
+                    Cadenya::Internal::Type::BaseStream[
+                      T.anything,
+                      Cadenya::Internal::Type::BaseModel
+                    ]
+                  ]
+                ),
               model: T.nilable(Cadenya::Internal::Type::Converter::Input),
               options: T.nilable(Cadenya::RequestOptions::OrHash)
             }
@@ -268,7 +276,15 @@ module Cadenya
                   ]
                 ]
               ),
-            stream: T.nilable(T::Class[T.anything]),
+            stream:
+              T.nilable(
+                T::Class[
+                  Cadenya::Internal::Type::BaseStream[
+                    T.anything,
+                    Cadenya::Internal::Type::BaseModel
+                  ]
+                ]
+              ),
             model: T.nilable(Cadenya::Internal::Type::Converter::Input),
             options: T.nilable(Cadenya::RequestOptions::OrHash)
           ).returns(T.anything)

data/rbi/cadenya/internal/type/base_stream.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Cadenya
+  module Internal
+    module Type
+      # @api private
+      #
+      # This module provides a base implementation for streaming responses in the SDK.
+      module BaseStream
+        include Enumerable
+
+        Message = type_member(:in)
+        Elem = type_member(:out)
+
+        sig { returns(Integer) }
+        attr_reader :status
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
+        sig { void }
+        def close
+        end
+
+        # @api private
+        sig { overridable.returns(T::Enumerable[Elem]) }
+        private def iterator
+        end
+
+        sig { params(blk: T.proc.params(arg0: Elem).void).void }
+        def each(&blk)
+        end
+
+        sig { returns(T::Enumerator[Elem]) }
+        def to_enum
+        end
+
+        # @api private
+        sig do
+          params(
+            model:
+              T.any(T::Class[T.anything], Cadenya::Internal::Type::Converter),
+            url: URI::Generic,
+            status: Integer,
+            headers: T::Hash[String, String],
+            response: Net::HTTPResponse,
+            unwrap:
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              ),
+            stream: T::Enumerable[Message]
+          ).void
+        end
+        def initialize(
+          model:,
+          url:,
+          status:,
+          headers:,
+          response:,
+          unwrap:,
+          stream:
+        )
+        end
+
+        # @api private
+        sig { returns(String) }
+        def inspect
+        end
+      end
+    end
+  end
+end