DodoPayments.Disputes (dodo_payments v0.1.0)

Payment dispute inspection.

Summary

Types

Parameters for disputes_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/disputes.ts declaration DisputeListParams.

Functions

list(client)

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

list(client, opts)

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

list(client, params, opts)

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

retrieve(client, dispute_id, opts \\ [])

Calls Dodo operation disputes_retrieve (GET /disputes/{dispute_id}). Required parameters: none.

Types

list_params()

@type list_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:created_at_gte) => String.t(),
    optional(:created_at_lte) => String.t(),
    optional(:customer_id) => String.t(),
    optional(:dispute_stage) => DodoPayments.Enums.dispute_stage(),
    optional(:dispute_status) => DodoPayments.Enums.dispute_status(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for disputes_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/disputes.ts declaration DisputeListParams.

Functions

list(client)

@spec list(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Page.Numbered.t(DodoPayments.DisputeListItem.t())}
  | {:error, Exception.t()}

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list(client, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.DisputeListItem.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.DisputeListItem.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

Pass a map for Dodo parameters or a keyword list for request-local options.

list(client, params, opts)

@spec list(DodoPayments.Client.t(), list_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.DisputeListItem.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.DisputeListItem.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation disputes_list (GET /disputes). Required parameters: none. Numbered pagination is zero-based.

Accepts both a Dodo parameter map and request-local options.

retrieve(client, dispute_id, opts \\ [])

@spec retrieve(DodoPayments.Client.t(), String.t() | integer(), keyword()) ::
  {:ok,
   DodoPayments.Dispute.t() | DodoPayments.Response.t(DodoPayments.Dispute.t())}
  | {:error, Exception.t()}

Calls Dodo operation disputes_retrieve (GET /disputes/{dispute_id}). Required parameters: none.

Options are request-local.