Synctera.Reconciliations (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Reconciliations' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Create a reconciliation — Create a new reconciliation job

Like create_reconciliation/2 but returns the value directly and raises on error.

Get reconciliation — Retrieves one reconciliation by id

Like get_reconciliation/3 but returns the value directly and raises on error.

List reconciliations — Retrieves paginated list of reconciliations

Like list_reconciliations/2 but returns the value directly and raises on error.

Functions

create_reconciliation(client, opts \\ [])

@spec create_reconciliation(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create a reconciliation — Create a new reconciliation job

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

create_reconciliation!(client, opts)

@spec create_reconciliation!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_reconciliation/2 but returns the value directly and raises on error.

get_reconciliation(client, reconciliation_id, opts \\ [])

@spec get_reconciliation(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get reconciliation — Retrieves one reconciliation by id

Options

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

get_reconciliation!(client, reconciliation_id, opts)

@spec get_reconciliation!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_reconciliation/3 but returns the value directly and raises on error.

list_reconciliations(client, opts \\ [])

@spec list_reconciliations(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List reconciliations — Retrieves paginated list of reconciliations

Options

Query options: :limit, :page_token

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

list_reconciliations!(client, opts)

@spec list_reconciliations!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_reconciliations/2 but returns the value directly and raises on error.