omise v0.1.4 Omise.Events

Provides Events API interfaces.

Summary

Functions

List all events

Retrieve an event

Functions

list(params \\ [])

Specs

list(Keyword.t) ::
  {:ok, [Omise.Event.t]} |
  {:error, Omise.Error.t}

List all events.

Returns {:ok, events} if the request is successful, {:error, error} otherwise.

Query Parameters:

  • offset - (optional, default: 0) The offset of the first record returned.
  • limit - (optional, default: 20, maximum: 100) The maximum amount of records returned.
  • from - (optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records.
  • to - (optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records.

Examples

{:ok, events} = Omise.Events.list

{:ok, events} = Omise.Events.list(limit: 10)
retrieve(id)

Specs

retrieve(String.t) ::
  {:ok, Omise.Event.t} |
  {:error, Omise.Error.t}

Retrieve an event.

Returns {:ok, event} if the request is successful, {:error, error} otherwise.

Examples

{:ok, event} = Omise.Events.retrieve("evnt_test_5285sfiqfo8t32x6h5h")