Synctera.InternalAccounts (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Internal Accounts' 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

Add internal accounts — Add an internal account

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

List internal accounts — Returns a list of all internal accounts.

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

Patch internal account — Patch internal account.

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

Functions

add_internal_accounts(client, opts \\ [])

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

Add internal accounts — Add an internal account

Options

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

add_internal_accounts!(client, opts)

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

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

list_internal_accounts(client, opts \\ [])

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

List internal accounts — Returns a list of all internal accounts.

Options

Query options: :limit, :page_token, :id

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

list_internal_accounts!(client, opts)

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

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

patch_internal_account(client, internal_account_id, opts \\ [])

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

Patch internal account — Patch internal account.

Options

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

patch_internal_account!(client, internal_account_id, opts)

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

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