Synctera.Statements (Synctera v1.0.0)

Synctera 'Statements' 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

get_statement(client, statement_id, opts \\ [])

Get a statement — Get a statement

get_statement!(client, statement_id, opts)

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

list_statements(client, opts \\ [])

List statements — Get list of statements

list_statements!(client, opts)

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

Functions

get_statement(client, statement_id, opts \\ [])

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

Get a statement — Get a statement

Options

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

get_statement!(client, statement_id, opts)

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

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

list_statements(client, opts \\ [])

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

List statements — Get list of statements

Options

Query options: :account_id

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

list_statements!(client, opts)

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

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