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

Create a business — Create a business who may act as a customer or a related business. You can then verify the identity of this customer and associate them with other people and accounts.

Options

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

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

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

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

Get business — Get business by ID.

Options

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

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

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

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

List business — Retrieves paginated list of businesses associated with the authorized requester.

Options

Query options: :id, :entity_name, :phone_number, :status, :is_customer, :sort_by, :limit, :page_token

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

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

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

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

Patch business — Update business by ID.

Options

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

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

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