Class: Polar::Resources::Events

Inherits:
Base
  • Object
show all
Defined in:
lib/polar/resources/events.rb

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Polar::Resources::Base

Instance Method Details

#get(id) ⇒ Hash

Get an event by ID

Parameters:

  • id (String) —

    Event ID

Returns:

  • (Hash) —

    Event data



30
31
32
33
 
# File 'lib/polar/resources/events.rb', line 30

def get(id)
  response = get("/events/#{id}")
  response.body
end

#ingest(events) ⇒ Hash

Ingest events

Parameters:

  • events (Array) —

    Array of event data

Returns:

  • (Hash) —

    Ingestion result



38
39
40
41
42
 
# File 'lib/polar/resources/events.rb', line 38

def ingest(events)
  body = { events: events }
  response = post('/events/', body)
  response.body
end

#list(params = {}) ⇒ PaginatedResponse

List events

Parameters:

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

    Query parameters

Options Hash (params):

  • :organization_id (String) —

    Filter by organization ID

  • :type (String) —

    Filter by event type

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Items per page

Returns:



15
16
17
 
# File 'lib/polar/resources/events.rb', line 15

def list(params = {})
  paginate('/events/', params)
end

#list_names(params = {}) ⇒ Array

List event names

Parameters:

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

    Query parameters

Returns:

  • (Array) —

    List of available event names



22
23
24
25
 
# File 'lib/polar/resources/events.rb', line 22

def list_names(params = {})
  response = get('/events/names', params)
  response.body
end