Class: Vonage::ProactiveConnect::Events

Inherits:
Namespace
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/vonage/proactive_connect/events.rb

Defined Under Namespace

Classes: ListResponse

Instance Method Summary collapse

Instance Method Details

#list(**params) ⇒ Object

Find all events

Examples:

response = proactive_connect.events.list

Parameters:

  • :page (optional, String) —

    Page of results to jump to

  • :page_size (optional, String) —

    Number of results per page

  • order (optional, String) —

    Sort in either ascending (asc, the default) or descending (desc) order

  • :run_id (optional, String) —

    Run IDs to filter by, if not specified, returns events for any run id

  • :type (optional, String) —

    Event types to filter by

  • action_id (optional, String) —

    Action IDs to filter by.

  • :invocation_id (optional, String) —

    Invocation IDs to filter by

  • :recipient_id (optional, String) —

    Recipient IDs to filter by

  • :run_item_id (optional, String) —

    Run item IDs to filter by

  • src_ctx (optional, String) —

    The name of the segment / matcher the item / event to filter by (exact string)

  • :src_type (optional, String) —

    Source types to filter by

  • :trace_id (optional, String) —

    Trace IDs to filter events by

  • date_start (optional, String) —

    ISO-8601 formatted date for when to begin events filter

  • :date_end (optional, String) —

    ISO-8601 formatted date for when to end events filter

See Also:



61
62
63
64
65
66
 
# File 'lib/vonage/proactive_connect/events.rb', line 61

def list(**params)
  path = "/v0.1/bulk/events"
  path += "?#{Params.encode(params)}" unless params.empty?

  request(path, response_class: ListResponse)
end