DodoPayments.UsageEvents (dodo_payments v0.1.0)

Usage event ingestion and inspection. Event IDs provide ingestion idempotency.

Summary

Types

Parameters for usage_events_ingest. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/usage-events.ts declaration UsageEventIngestParams.

list_params()

Parameters for usage_events_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/usage-events.ts declaration UsageEventListParams.

Functions

ingest(client, params)

Calls Dodo operation usage_events_ingest (POST /events/ingest). Required parameters: :events.

ingest(client, params, opts)

Calls Dodo operation usage_events_ingest (POST /events/ingest). Required parameters: :events.

list(client)

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

retrieve(client, event_id, opts \\ [])

Calls Dodo operation usage_events_retrieve (GET /events/{event_id}). Required parameters: none.

Types

ingest_params()

@type ingest_params() ::
  %{
    :events => [DodoPayments.RequestTypes.usage_event_input()],
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:customer_id) => String.t(),
    optional(:end) => String.t(),
    optional(:event_name) => String.t(),
    optional(:meter_id) => String.t(),
    optional(:start) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Functions

ingest(client, params)

@spec ingest(DodoPayments.Client.t(), ingest_params()) ::
  {:ok, DodoPayments.UsageEventIngestResponse.t()} | {:error, Exception.t()}

Calls Dodo operation usage_events_ingest (POST /events/ingest). Required parameters: :events.

API parameters must be supplied as a map.

ingest(client, params, opts)

@spec ingest(DodoPayments.Client.t(), ingest_params(), keyword()) ::
  {:ok,
   DodoPayments.UsageEventIngestResponse.t()
   | DodoPayments.Response.t(DodoPayments.UsageEventIngestResponse.t())}
  | {:error, Exception.t()}

Calls Dodo operation usage_events_ingest (POST /events/ingest). Required parameters: :events.

The final argument contains request-local options.

list(client)

@spec list(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Page.Numbered.t(DodoPayments.UsageEvent.t())}
  | {:error, Exception.t()}

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.UsageEvent.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.UsageEvent.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

Pass a map for Dodo parameters or a keyword list for request-local options.

list(client, params, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.UsageEvent.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.UsageEvent.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation usage_events_list (GET /events). Required parameters: none. Numbered pagination is zero-based.

Accepts both a Dodo parameter map and request-local options.

retrieve(client, event_id, opts \\ [])

@spec retrieve(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.UsageEvent.t()
   | DodoPayments.Response.t(DodoPayments.UsageEvent.t())}
  | {:error, Exception.t()}

Calls Dodo operation usage_events_retrieve (GET /events/{event_id}). Required parameters: none.

Options are request-local.