Class: Believe::Resources::Stream

Inherits:

Object

• Object
• Believe::Resources::Stream

Defined in:

lib/believe/resources/stream.rb

Overview

Server-Sent Events (SSE) streaming endpoints

Instance Method Summary

• #initialize(client:) ⇒ Stream constructor private

  A new instance of Stream.

• #test_connection(request_options: {}) ⇒ Object

  A simple SSE test endpoint that streams numbers 1-5.

Constructor Details

#initialize(client:) ⇒ Stream

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Stream.

Parameters:

• client (::Believe::Client)

# File 'lib/believe/resources/stream.rb', line 28

def initialize(client:)
  @client = client
end

Instance Method Details

#test_connection(request_options: {}) ⇒ Object

A simple SSE test endpoint that streams numbers 1-5.

Parameters:

• request_options (::Believe::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Object)

See Also:

• Models::StreamTestConnectionParams

# File 'lib/believe/resources/stream.rb', line 16

def test_connection(params = {})
  @client.request(
    method: :get,
    path: "stream/test",
    model: ::Believe::Internal::Type::Unknown,
    options: params[:request_options]
  )
end