Class: ModernTreasury::Resources::Events

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

Instance Method Summary collapse

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:



64
65
66
 
# File 'lib/modern_treasury/resources/events.rb', line 64

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after_cursor: nil, entity_id: nil, event_name: nil, event_time_end: nil, event_time_start: nil, per_page: nil, resource: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::Event>

list events

Parameters:

  • after_cursor (String, nil)
  • entity_id (String)
  • event_name (String)
  • event_time_end (Time) —

    An inclusive upper bound for when the event occurred

  • event_time_start (Time) —

    An inclusive lower bound for when the event occurred

  • per_page (Integer)
  • resource (String)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/modern_treasury/resources/events.rb', line 49

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

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::Event

get event

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/modern_treasury/resources/events.rb', line 17

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