Class: Increase::Resources::Events

Inherits:

Object

• Object
• Increase::Resources::Events

Defined in:

lib/increase/resources/events.rb

Instance Method Summary

• #initialize(client:) ⇒ Events constructor private

  A new instance of Events.

• #list(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Event>

  Some parameter documentations has been truncated, see Models::EventListParams for more details.

• #retrieve(event_id, request_options: {}) ⇒ Increase::Models::Event

  Retrieve an Event.

Constructor Details

#initialize(client:) ⇒ Events

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Events.

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/events.rb', line 63

def initialize(client:)
  @client = client
end

Instance Method Details

#list(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Event>

Some parameter documentations has been truncated, see Models::EventListParams for more details.

List Events

Parameters:

• associated_object_id (String) —

  Filter Events to those belonging to the object with the provided identifier.

• category (Increase::Models::EventListParams::Category)
• created_at (Increase::Models::EventListParams::CreatedAt)
• cursor (String) —

  Return the page of entries after this one.

• limit (Integer) —

  Limit the size of the list that is returned. The default (and maximum) is 100 ob

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Internal::Page<Increase::Models::Event>)

See Also:

• Models::EventListParams

# File 'lib/increase/resources/events.rb', line 48

def list(params = {})
  parsed, options = Increase::EventListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "events",
    query: parsed,
    page: Increase::Internal::Page,
    model: Increase::Event,
    options: options
  )
end

#retrieve(event_id, request_options: {}) ⇒ Increase::Models::Event

Retrieve an Event

Parameters:

• event_id (String) —

  The identifier of the Event.

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::Event)

See Also:

• Models::EventRetrieveParams

# File 'lib/increase/resources/events.rb', line 17

def retrieve(event_id, params = {})
  @client.request(
    method: :get,
    path: ["events/%1$s", event_id],
    model: Increase::Event,
    options: params[:request_options]
  )
end