Polarex.Disputes (Polarex v0.3.0)

View Source

Provides API endpoints related to disputes

Summary

Functions

disputes_get(id, opts \\ [])

@spec disputes_get(id :: String.t(), opts :: keyword()) ::
  {:ok, Polarex.Dispute.t()}
  | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}

Get Dispute

Get a dispute by ID.

Scopes: disputes:read

disputes_list(opts \\ [])

@spec disputes_list(opts :: keyword()) ::
  {:ok, Polarex.ListResourceDispute.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Disputes

List disputes.

Scopes: disputes:read

Options

  • organization_id: Filter by organization ID.
  • order_id: Filter by order ID.
  • status: Filter by dispute status.
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.