Class: OpenapiClient::StreamApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/stream_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StreamApi

Returns a new instance of StreamApi.



19
20
21
 
# File 'lib/openapi_client/api/stream_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/stream_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#stream_deliveries_get(opts = {}) ⇒ String

Real-time delivery event stream (SSE) Server-Sent Events stream of webhook deliveries

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :endpoint_id (String)
  • :status (String)
  • :limit (Integer) — default: default to 50

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/openapi_client/api/stream_api.rb', line 29

def stream_deliveries_get(opts = {})
  data, _status_code, _headers = stream_deliveries_get_with_http_info(opts)
  data
end

#stream_deliveries_get_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Real-time delivery event stream (SSE) Server-Sent Events stream of webhook deliveries

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :endpoint_id (String)
  • :status (String)
  • :limit (Integer) — default: default to 50

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/openapi_client/api/stream_api.rb', line 41

def stream_deliveries_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.stream_deliveries_get ...'
  end
  # resource path
  local_var_path = '/stream/deliveries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'endpoint_id'] = opts[:'endpoint_id'] if !opts[:'endpoint_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/event-stream']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"StreamApi.stream_deliveries_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StreamApi#stream_deliveries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end