Omise.Dispute (omise v0.10.0)
Provides Dispute API interfaces.
Summary
Functions
Destroy a document.
List all disputes.
List all dispute documents.
Retrieve a dispute.
Retrieve a dispute document.
Search all the disputes.
Update a dispute.
Upload a document.
Types
@type t() :: %Omise.Dispute{ amount: integer(), charge: String.t(), closed_at: String.t(), created: String.t(), currency: String.t(), documents: Omise.List.t(), funding_amount: integer(), funding_currency: String.t(), id: String.t(), livemode: boolean(), location: String.t(), message: String.t(), object: String.t(), reason_code: String.t(), reason_message: String.t(), status: String.t(), transaction: String.t(), transactions: list() }
Functions
destroy_document(id, document_id, opts \\ [])
@spec destroy_document(String.t(), String.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
Destroy a document.
Returns {:ok, document} if the request is successful, {:error, error} otherwise.
Examples
Omise.Dispute.destroy_document("dspt_test_4zgf15h89w8t775kcm8", "docu_test_55alwcu1phxmsxx3y9p")list(params \\ [], opts \\ [])
@spec list(Keyword.t(), Keyword.t()) :: {:ok, struct()} | {: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
# List all disputes
Omise.Dispute.list
# List all open disputes
Omise.Dispute.list(status: "open")
# List all pending disputes
Omise.Dispute.list(status: "pending")
# List all closed disputes
Omise.Dispute.list(status: "closed")list_documents(id, params \\ [], opts \\ [])
@spec list_documents(String.t(), Keyword.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
List all dispute documents.
Returns {:ok, documents} if the request is successful, {:error, error} otherwise.
Examples
Omise.Dispute.list_documents("dspt_5089off452g5m5te7xs")retrieve(id, opts \\ [])
@spec retrieve(String.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
Retrieve a dispute.
Returns {:ok, dispute} if the request is successful, {:error, error} otherwise.
Examples
Omise.Dispute.retrieve("dspt_test_51yfnnpsxajeybpytm4")retrieve_document(id, document_id, opts \\ [])
@spec retrieve_document(String.t(), String.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
Retrieve a dispute document.
Returns {:ok, document} if the request is successful, {:error, error} otherwise.
Examples
Omise.Dispute.retrieve_document("dspt_test_55aj9q9iipt3tcdwb5r", "docu_test_55alwcu1phxmsxx3y9p")search(params \\ [], opts \\ [])
@spec search(Keyword.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
Search all the disputes.
Returns {:ok, disputes} if the request is successful, {:error, error} otherwise.
Query Parameters:
<https://www.omise.co/search-query-and-filters>Examples
Omise.Dispute.search(filters: [status: "pending"])
Omise.Dispute.search(query: "dspt_5089off452g5m5te7xs")update(id, params, opts \\ [])
@spec update(String.t(), Keyword.t(), Keyword.t()) :: {:ok, struct()} | {: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
Omise.Dispute.update("dspt_test_4zgf15h89w8t775kcm8", message: "Shut up and dance with me!")upload_document(id, params \\ [], opts \\ [])
@spec upload_document(String.t(), Keyword.t(), Keyword.t()) :: {:ok, struct()} | {:error, Omise.Error.t()}
Upload a document.
Returns {:ok, document} if the request is successful, {:error, error} otherwise.
Request Parameter:
file- (required) The file to upload. Valid files include PNG and JPG images and PDF files. The uploaded file should also includes metadata such as filename and content type.
Examples
Omise.Dispute.upload_document("dspt_test_4zgf15h89w8t775kcm8", file: "rick-and-morty.jpg")