Class: SimpleSpark::Endpoints::MessageEvents
- Inherits:
-
Object
- Object
- SimpleSpark::Endpoints::MessageEvents
- Defined in:
- lib/simple_spark/endpoints/message_events.rb
Overview
Provides access to the /message-events endpoint
Instance Attribute Summary collapse
-
#client ⇒ Object
Returns the value of attribute client.
Instance Method Summary collapse
-
#initialize(client) ⇒ MessageEvents
constructor
A new instance of MessageEvents.
-
#samples(events = nil) ⇒ Array
Returns sample message_events.
-
#search(params = {}) ⇒ Array
Perform a filtered search for message event data.
Constructor Details
#initialize(client) ⇒ MessageEvents
Returns a new instance of MessageEvents.
8 9 10 |
# File 'lib/simple_spark/endpoints/message_events.rb', line 8 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ Object
Returns the value of attribute client.
6 7 8 |
# File 'lib/simple_spark/endpoints/message_events.rb', line 6 def client @client end |
Instance Method Details
#samples(events = nil) ⇒ Array
Returns sample message_events
17 18 19 20 |
# File 'lib/simple_spark/endpoints/message_events.rb', line 17 def samples(events = nil) query_params = events.nil? ? {} : { events: events } @client.call(method: :get, path: 'message-events/events/samples', query_values: query_params) end |
#search(params = {}) ⇒ Array
Perform a filtered search for message event data. The response is sorted by descending timestamp.
26 27 28 |
# File 'lib/simple_spark/endpoints/message_events.rb', line 26 def search(params = {}) @client.call(method: :get, path: 'message-events', query_values: params) end |