BexioApiClient.Others (bexio_api_client v0.2.17)
Bexio API for the other endpoints.
Link to this section Summary
Functions
Create a fictional user, the id of the fictional user will be ignored!
Create a task.
Create a unit.
Create a fictional user
Delete a task.
Delete a unit.
Edut a task.
Edit a unit.
Fetch a single company profile
Fetch a list of company profiles.
Fetch a list of countries.
Fetch a single country
Fetch a finctional user.
Fetch a list of finctional users.
Fetch a list of languages.
Fetch a task.
Fetch a list of task priorities.
Fetch a list of task status.
Fetch a list of tasks.
Fetch a unit.
Fetch a list of units.
Fetch a single user.
Fetch a list of users.
Get access information of logged in user
Search countries via query. The following search fields are supported
Search languages via query. The following search fields are supported
Search a task
Search a unit
Create a fictional user
Link to this section Types
tesla_error_type()
@type tesla_error_type() :: BexioApiClient.Helpers.tesla_error_type()
Link to this section Functions
create_fictional_user(client, fictional_user)
@spec create_fictional_user( client :: Tesla.Client.t(), finctional_user :: BexioApiClient.Others.FictionalUser.t() ) :: {:ok, BexioApiClient.Others.FictionalUser.t()} | tesla_error_type()
Create a fictional user, the id of the fictional user will be ignored!
create_task(client, task)
@spec create_task(client :: Tesla.Client.t(), task :: Task.t()) :: {:ok, Task.t()} | tesla_error_type()
Create a task.
create_unit(client, name)
@spec create_unit(client :: Tesla.Client.t(), name :: String.t()) :: {:ok, %{id: integer(), name: String.t()}} | tesla_error_type()
Create a unit.
delete_fictional_user(client, id)
@spec delete_fictional_user(client :: Tesla.Client.t(), id :: integer()) :: {:ok, true | false} | tesla_error_type()
Create a fictional user
delete_task(client, id)
@spec delete_task(client :: Tesla.Client.t(), id :: integer()) :: {:ok, Task.t()} | tesla_error_type()
Delete a task.
delete_unit(client, id)
@spec delete_unit(client :: Tesla.Client.t(), id :: integer()) :: {:ok, Task.t()} | tesla_error_type()
Delete a unit.
edit_task(client, task)
@spec edit_task(client :: Tesla.Client.t(), task :: Task.t()) :: {:ok, Task.t()} | tesla_error_type()
Edut a task.
edit_unit(client, id, name)
@spec edit_unit(client :: Tesla.Client.t(), id :: integer(), name :: String.t()) :: {:ok, %{id: integer(), name: String.t()}} | tesla_error_type()
Edit a unit.
enabled(binary)
fetch_company_profile(client, id)
@spec fetch_company_profile(client :: Tesla.Client.t(), id :: non_neg_integer()) :: {:ok, BexioApiClient.Others.CompanyProfile.t()} | tesla_error_type()
Fetch a single company profile
fetch_company_profiles(client)
@spec fetch_company_profiles(client :: Tesla.Client.t()) :: {:ok, [BexioApiClient.Others.CompanyProfile.t()]} | tesla_error_type()
Fetch a list of company profiles.
fetch_countries(client)
@spec fetch_countries(client :: Tesla.Client.t()) :: {:ok, [BexioApiClient.Others.Country.t()]} | tesla_error_type()
Fetch a list of countries.
fetch_country(client, id)
@spec fetch_country(client :: Tesla.Client.t(), id :: non_neg_integer()) :: {:ok, BexioApiClient.Others.Country.t()} | tesla_error_type()
Fetch a single country
fetch_fictional_user(client, id)
@spec fetch_fictional_user(client :: Tesla.Client.t(), id :: integer()) :: {:ok, BexioApiClient.Others.FictionalUser.t()} | tesla_error_type()
Fetch a finctional user.
fetch_fictional_users(client)
@spec fetch_fictional_users(client :: Tesla.Client.t()) :: {:ok, [BexioApiClient.Others.FictionalUser.t()]} | tesla_error_type()
Fetch a list of finctional users.
fetch_languages(client)
@spec fetch_languages(client :: Tesla.Client.t()) :: {:ok, [BexioApiClient.Others.Language.t()]} | tesla_error_type()
Fetch a list of languages.
fetch_task(client, id)
@spec fetch_task(client :: Tesla.Client.t(), id :: integer()) :: {:ok, Task.t()} | tesla_error_type()
Fetch a task.
fetch_task_priorities(client, opts \\ [])
@spec fetch_task_priorities( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, map()} | tesla_error_type()
Fetch a list of task priorities.
fetch_task_status(client, opts \\ [])
@spec fetch_task_status( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, map()} | tesla_error_type()
Fetch a list of task status.
fetch_tasks(client, opts \\ [])
@spec fetch_tasks( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [Task.t()]} | tesla_error_type()
Fetch a list of tasks.
fetch_unit(client, id)
@spec fetch_unit(client :: Tesla.Client.t(), id :: integer()) :: {:ok, %{id: integer(), name: String.t()}} | tesla_error_type()
Fetch a unit.
fetch_units(client, opts \\ [])
@spec fetch_units( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()] ) :: {:ok, map()} | tesla_error_type()
Fetch a list of units.
fetch_user(client, user_id)
@spec fetch_user(client :: Tesla.Client.t(), user_id :: non_neg_integer()) :: {:ok, BexioApiClient.Others.User.t()} | tesla_error_type()
Fetch a single user.
fetch_users(client)
@spec fetch_users(client :: Tesla.Client.t()) :: {:ok, [BexioApiClient.Others.User.t()]} | tesla_error_type()
Fetch a list of users.
get_access_information(client)
@spec get_access_information(client :: Tesla.Client.t()) :: {:ok, BexioApiClient.Others.Permission.t()} | tesla_error_type()
Get access information of logged in user
restriction(binary)
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()]} | tesla_error_type()
Search countries via query. The following search fields are supported:
- name
- name_short
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()]} | tesla_error_type()
Search languages via query. The following search fields are supported:
- name
- iso_639_1
search_tasks(client, criteria, opts \\ [])
@spec search_tasks( client :: Tesla.Client.t(), criteria :: [BexioApiClient.SearchCriteria.t()], opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [Task.t()]} | tesla_error_type()
Search a task
Following fields are supported:
subject
updated_at
user_id
contact_id
todo_status_id
module_id
entry_id
search_units(client, criteria, opts \\ [])
@spec search_units( client :: Tesla.Client.t(), criteria :: [BexioApiClient.SearchCriteria.t()], opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, map()} | tesla_error_type()
Search a unit
Following fields are supported:
name
update_fictional_user(client, fictional_user)
@spec update_fictional_user( client :: Tesla.Client.t(), fictional_user :: BexioApiClient.Others.FictionalUser.t() ) :: {:ok, BexioApiClient.Others.FictionalUser.t()} | tesla_error_type()
Create a fictional user