mangopay v0.1.0 MangoPay.DisputeDocument

Functions for MangoPay dispute document.

Link to this section Summary

Functions

All dispute documents by dispute

All dispute documents by dispute

Consult a dispute document page

Consult a dispute document page

Create a dispute document

Create a dispute document

Create a page for a dispute document

Create a page for a dispute document

Get a dispute

Get a dispute

Get path called

Get path called

Submit a dispute document

Submit a dispute document

Link to this section Functions

Link to this function all_by_dispute(id, query \\ %{})

All dispute documents by dispute.

Examples

dispute_id        = Id of a dispute object
query             = %{
                      "Page": 1,
                      "Per_Page": 25,
                      "Sort": "CreationDate:DESC",
                      "BeforeDate": 1463440221,
                      "AfterDate": 1431817821,
                      "Status": "CREATED, SUCCEEDED",
                      "Type": "DELIVERY_PROOF"
                    }
{:ok, dispute_documents} = MangoPay.DisputeDocument.all_by_dispute(dispute_id, query)
Link to this function all_by_dispute!(id, query \\ %{})

All dispute documents by dispute.

Examples

dispute_id        = Id of a dispute object
query             = %{
                      "Page": 1,
                      "Per_Page": 25,
                      "Sort": "CreationDate:DESC",
                      "BeforeDate": 1463440221,
                      "AfterDate": 1431817821,
                      "Status": "CREATED, SUCCEEDED",
                      "Type": "DELIVERY_PROOF"
                    }
dispute_documents = MangoPay.DisputeDocument.all_by_dispute!(dispute_id, query)

Consult a dispute document page.

Examples

{:ok, dispute_document} = MangoPay.DisputeDocument.consult(dispute_id)

Consult a dispute document page.

Examples

dispute_document = MangoPay.DisputeDocument.consult!("dispute_id")
Link to this function create(dispute_id, params)

Create a dispute document.

Examples

params                  = %{
  "Tag": "custom meta",
  "Type": "DELIVERY_PROOF"
}
{:ok, dispute_document} = MangoPay.DisputeDocument.create("dispute_id", params)
Link to this function create!(dispute_id, params)

Create a dispute document.

Examples

params           = %{
  "Tag": "custom meta",
  "Type": "DELIVERY_PROOF"
}
dispute_document = MangoPay.DisputeDocument.create!("dispute_id", params)
Link to this function create_page(dispute_id, dispute_document_id, params)

Create a page for a dispute document.

Examples

params                  = %{
  File: "blahblah"
}
{:ok, dispute_document_page} = MangoPay.DisputeDocument.create_page("dispute_id", "dispute_document_id", params)
Link to this function create_page!(dispute_id, dispute_document_id, params)

Create a page for a dispute document.

Examples

params                = %{
  File: "blahblah"
}
dispute_document_page = MangoPay.DisputeDocument.create_page!("dispute_id", "dispute_document_id", params)

Get a dispute.

Examples

{:ok, dispute} = MangoPay.DisputeDocument.get(id)

Get a dispute.

Examples

dispute = MangoPay.DisputeDocument.get!(id)

Get path called.

Examples

"/users" = MangoPay.User.path()

Get path called.

Examples

"/users/id" = MangoPay.User.path(id)
Link to this function resource_document(dispute_id)
Link to this function resource_document(dispute_id, dispute_document_id)
Link to this function submit(dispute_id, dispute_document_id)

Submit a dispute document.

Examples

params                  = %{
  "Status": "CREATED"
}
{:ok, dispute_document} = MangoPay.DisputeDocument.submit("dispute_id", params)
Link to this function submit!(dispute_id, dispute_document_id)

Submit a dispute document.

Examples

params           = %{
  "Status": "CREATED"
}
dispute_document = MangoPay.DisputeDocument.submit!("dispute_id", params)