Class: Rafflesia::EpisodeEvents

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/episode_events.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ EpisodeEvents

Returns a new instance of EpisodeEvents.



9
10
11
 
# File 'lib/rafflesia/episode_events.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#list(episode_id: nil, limit: 25, starting_after: nil, request_options: {}) ⇒ Rafflesia::EnvelopeListEpisodeEvent

GET /v1/episode_events

Parameters:

  • episode_id (String, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: 25)
  • starting_after (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rafflesia/episode_events.rb', line 19

def list(
  episode_id: nil,
  limit: 25,
  starting_after: nil,
  request_options: {}
)
  params = {
    'episode_id' => episode_id,
    'limit' => limit,
    'starting_after' => starting_after
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/episode_events',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeListEpisodeEvent.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end