Polarex.EventTypes (Polarex v0.3.0)

View Source

Provides API endpoints related to event types

Summary

Functions

event_types_list(opts \\ [])

@spec event_types_list(opts :: keyword()) ::
  {:ok, Polarex.ListResourceEventTypeWithStats.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Event Types

List event types with aggregated statistics.

Scopes: events:read events:write

Options

  • organization_id: Filter by organization ID.
  • customer_id: Filter by customer ID.
  • external_customer_id: Filter by external customer ID.
  • query: Query to filter event types by name or label.
  • root_events: When true, only return event types with root events (parent_id IS NULL).
  • parent_id: Filter by specific parent event ID.
  • source: Filter by event source (system or user).
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

event_types_update(id, body, opts \\ [])

@spec event_types_update(
  id :: String.t(),
  body :: Polarex.EventTypeUpdate.t(),
  opts :: keyword()
) ::
  {:ok, Polarex.EventType.t()} | {:error, Polarex.HTTPValidationError.t()}

Update Event Type

Update an event type's label.

Scopes: events:write

Request Body

Content Types: application/json