AgentPushKit.Api.Events (agent_push_kit v0.1.0)

@spec get_event(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.EventDetail.t()}
  | {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Get one event including metadata

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
event_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.EventDetail.t} on success
{:error, Tesla.Env.t} on failure

list_events(connection, organization_id, opts \\ [])

@spec list_events(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.EventPage.t()}
  | {:error, Tesla.Env.t()}

List a paginated inbox

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
opts (keyword): Optional parameters
- :service (String.t):
- :type (String.t):
- :search (String.t):
- :cursor (String.t):
- :limit (integer()):

Returns

{:ok, AgentPushKit.Model.EventPage.t} on success
{:error, Tesla.Env.t} on failure

list_notification_types(connection, organization_id, opts \\ [])

@spec list_notification_types(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, [String.t()]}
  | {:error, Tesla.Env.t()}

List distinct notification types

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
opts (keyword): Optional parameters
- :serviceId (String.t): Optionally restrict types to one service ID.

Returns

{:ok, [%String.t{}, ...]} on success
{:error, Tesla.Env.t} on failure

list_services(connection, organization_id, opts \\ [])

@spec list_services(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [AgentPushKit.Model.Service.t()]}
  | {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

List services discovered from ingested events

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, [%Service{}, ...]} on success
{:error, Tesla.Env.t} on failure

search_events(connection, organization_id, search_events_input, opts \\ [])

@spec search_events(
  Tesla.Env.client(),
  String.t(),
  AgentPushKit.Model.SearchEventsInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.EventPage.t()}
  | {:error, Tesla.Env.t()}

Search events with a validated Boolean filter tree

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
search_events_input (SearchEventsInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.EventPage.t} on success
{:error, Tesla.Env.t} on failure

send_event(connection, send_event_input, opts \\ [])

@spec send_event(Tesla.Env.client(), AgentPushKit.Model.SendEventInput.t(), keyword()) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.IngestionResult.t()}
  | {:error, Tesla.Env.t()}

Send an event using an application ingestion key

Parameters

connection (AgentPushKit.Connection): Connection to server
send_event_input (SendEventInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.IngestionResult.t} on success
{:error, Tesla.Env.t} on failure

send_event_as_user(connection, organization_id, send_event_input, opts \\ [])

@spec send_event_as_user(
  Tesla.Env.client(),
  String.t(),
  AgentPushKit.Model.SendEventInput.t(),
  keyword()
) ::
  {:ok, AgentPushKit.Model.ErrorResponse.t()}
  | {:ok, AgentPushKit.Model.IngestionResult.t()}
  | {:error, Tesla.Env.t()}

Send an event as an authenticated user or agent

Parameters

connection (AgentPushKit.Connection): Connection to server
organization_id (String.t):
send_event_input (SendEventInput):
opts (keyword): Optional parameters

Returns

{:ok, AgentPushKit.Model.IngestionResult.t} on success
{:error, Tesla.Env.t} on failure