BexioApiClient.Others (bexio_api_client v0.1.6)

Bexio API for the other endpoints.

Link to this section Summary

Functions

Fetch a single company profile

Fetch a list of company profiles.

Fetch a list of countries.

Fetch a single country

Fetch a list of languages.

Search countries via query. The following search fields are supported

Search languages via query. The following search fields are supported

Link to this section Functions

Link to this function

fetch_company_profile(client, id)

@spec fetch_company_profile(client :: Tesla.Client.t(), id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Others.CompanyProfile.t()} | {:error, any()}

Fetch a single company profile

Link to this function

fetch_company_profiles(client)

@spec fetch_company_profiles(client :: Tesla.Client.t()) ::
  {:ok, [BexioApiClient.Others.CompanyProfile.t()]} | {:error, any()}

Fetch a list of company profiles.

Link to this function

fetch_countries(client)

@spec fetch_countries(client :: Tesla.Client.t()) ::
  {:ok, [BexioApiClient.Others.Country.t()]} | {:error, any()}

Fetch a list of countries.

Link to this function

fetch_country(client, id)

@spec fetch_country(client :: Tesla.Client.t(), id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Others.Country.t()} | {:error, any()}

Fetch a single country

Link to this function

fetch_languages(client)

@spec fetch_languages(client :: Tesla.Client.t()) ::
  {:ok, [BexioApiClient.Others.Language.t()]} | {:error, any()}

Fetch a list of languages.

Link to this function

search_countries(client, criteria, opts \\ [])

@spec search_countries(
  client :: Tesla.Client.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Others.Country.t()]} | {:error, any()}

Search countries via query. The following search fields are supported:

  • name
  • name_short
Link to this function

search_languages(client, criteria, opts \\ [])

@spec search_languages(
  client :: Tesla.Client.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Others.Language.t()]} | {:error, any()}

Search languages via query. The following search fields are supported:

  • name
  • iso_639_1