GoCardlessClient.Resources.Creditors (GoCardlessClient v2.0.0)

GoCardlessClient Creditors API.

See https://developer.gocardless.com/api-reference/#creditors for full documentation.

Summary

Functions

collect_all(client, params \\ %{}, opts \\ [])

Eagerly collects all creditors into a list across all pages.

create(client, params, opts \\ [])

Creates a new creditors resource.

get(client, id, opts \\ [])

Retrieves a single creditors by ID.

list(client, params \\ %{}, opts \\ [])

Lists creditors with optional filter params.

stream(client, params \\ %{}, opts \\ [])

Returns a lazy Stream over all pages of creditors.

update(client, id, params, opts \\ [])

Updates a creditors.

Functions

collect_all(client, params \\ %{}, opts \\ [])

@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, [map()]}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Eagerly collects all creditors into a list across all pages.

create(client, params, opts \\ [])

@spec create(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Creates a new creditors resource.

get(client, id, opts \\ [])

@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Retrieves a single creditors by ID.

list(client, params \\ %{}, opts \\ [])

@spec list(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, %{items: [map()], meta: map()}}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Lists creditors with optional filter params.

stream(client, params \\ %{}, opts \\ [])

@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()

Returns a lazy Stream over all pages of creditors.

update(client, id, params, opts \\ [])

@spec update(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Updates a creditors.