Module: Oktakit::Client::Events

Included in:
Oktakit::Client
Defined in:
lib/oktakit/client/events.rb

Instance Method Summary collapse

Instance Method Details

#list_events(options = {}) ⇒ Array<Sawyer::Resource>

List Events

Examples:

Oktakit.list_events

Parameters:

  • options (:query) (defaults to: {})
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {})
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {})
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {})
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {})

    Optional. Body params for request.

Returns:

  • (Array<Sawyer::Resource>)

    Array of Events

See Also:



15
16
17
# File 'lib/oktakit/client/events.rb', line 15

def list_events(options = {})
  get('/events', options)
end