omise v0.1.4 Omise.Disputes
Provides Disputes API interfaces.
Summary
Functions
Specs
list(Keyword.t) ::
{:ok, [Omise.Dispute.t]} |
{:error, Omise.Error.t}
List all disputes.
Returns {:ok, disputes}
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, all_disputes} = Omise.Disputes.list
{:ok, open_disputes} = Omise.Disputes.list(status: "open")
{:ok, pending_disputes} = Omise.Disputes.list(status: "pending")
{:ok, closed_isputes} = Omise.Disputes.list(status: "closed")
Specs
retrieve(String.t) ::
{:ok, Omise.Dispute.t} |
{:error, Omise.Error.t}
Retrieve a dispute.
Returns {:ok, dispute}
if the request is successful, {:error, error}
otherwise.
Examples
{:ok, dispute} = Omise.Disputes.retrieve("dspt_test_51yfnnpsxajeybpytm4")
Specs
update(String.t, Keyword.t) ::
{:ok, Omise.Dispute.t} |
{:error, Omise.Error.t}
Update a dispute.
Returns {:ok, dispute}
if the request is successful, {:error, error}
otherwise.
Request Parameter:
message
- The new dispute message.
Examples
{:ok, dispute} = Omise.Disputes.update("dspt_test_4zgf15h89w8t775kcm8", message: "Hello, it's me")