Class: MethodRuby::Resources::Events

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

Overview

Webhook event log

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:



79
80
81
 
# File 'lib/method_ruby/resources/events.rb', line 79

def initialize(client:)
  @client = client
end

Instance Method Details

#list(method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, type: nil, request_options: {}) ⇒ MethodRuby::Models::EventListResponse

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

Returns a paginated list of webhook event records.

Parameters:

  • method_version (Symbol, MethodRuby::Models::EventListParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • from_date (Date) —

    Query param: Filter results from this date (inclusive, YYYY-MM-DD format).

  • page (Integer) —

    Query param: Page number for pagination (1-indexed).

  • page_cursor (String) —

    Query param: Cursor for cursor-based pagination. Use the value from ‘Pagination-

  • page_limit (Integer) —

    Query param: Number of items per page.

  • to_date (Date) —

    Query param: Filter results to this date (inclusive, YYYY-MM-DD format).

  • type (String) —

    Query param: Filter events by event type.

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/method_ruby/resources/events.rb', line 61

def list(params)
  query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date, :type]
  parsed, options = MethodRuby::EventListParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "events",
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::EventListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(evt_id, method_version:, request_options: {}) ⇒ MethodRuby::Models::EventRetrieveResponse

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

Returns a single event by its identifier.

Parameters:

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/method_ruby/resources/events.rb', line 23

def retrieve(evt_id, params)
  parsed, options = MethodRuby::EventRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["events/%1$s", evt_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::EventRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end