Class: Basecamp::Services::EventsService

Inherits:
BaseService show all
Defined in:
lib/basecamp/generated/services/events_service.rb

Overview

Service for Events operations

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from Basecamp::Services::BaseService

Instance Method Details

#list(recording_id:, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

List all events for a recording

Parameters:

  • recording_id (Integer) —

    recording id ID

  • page (Integer, nil) (defaults to: nil) —

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

  • max_items (Integer, nil) (defaults to: nil) —

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



15
16
17
18
19
20
 
# File 'lib/basecamp/generated/services/events_service.rb', line 15

def list(recording_id:, page: nil, max_items: nil)
  wrap_paginated(service: "events", operation: "list", is_mutation: false, resource_id: recording_id) do
    params = compact_query_params(page: page)
    paginate("/recordings/#{recording_id}/events.json", params: params, operation: "ListEvents", max_items: max_items)
  end
end