bexio_api_client
v0.7.0

BexioApiClient.Contacts (bexio_api_client v0.7.0)

Bexio API for the contacts part of the API.

Link to this section Summary

Types

api_error_type()

Functions

fetch_additional_address(req, contact_id, additional_address_id)

This action fetches a single additional address

fetch_additional_addresses(req, contact_id, opts \\ [])

Fetch a list of additional addresses.

fetch_contact(req, contact_id, show_archived \\ nil)

This action fetches a single contact

fetch_contact_group(req, contact_group_id)

This action fetches a single contact group

fetch_contact_groups(req, opts \\ [])

Fetch a list of contacts groups.

fetch_contact_relation(req, contact_relation_id)

This action fetches a single contact relation

fetch_contact_relations(req, opts \\ [])

Fetch a list of contacts relations.

fetch_contact_sectors(req, opts \\ [])

Fetch a list of contacts sectors.

fetch_contacts(req, show_archived \\ false, opts \\ [])

Fetch a list of contacts.

fetch_salutation(req, salutation_id)

This action fetches a single salutation

fetch_salutations(req, opts \\ [])

Fetch a list of additional addresses.

fetch_title(req, title_id)

This action fetches a single title

fetch_titles(req, opts \\ [])

Fetch a list of titles.

search_additional_addresses(req, contact_id, criteria, opts \\ [])

Search additional addresses via query. The following search fields are supported

search_contact_groups(req, criteria, opts \\ [])

Search contact groups via query. The following search fields are supported

search_contact_relations(req, criteria, opts \\ [])

Search contacts groups via query. The following search fields are supported

search_contact_sectors(req, criteria, opts \\ [])

Search contact sectors via query. The following search fields are supported

search_contacts(req, criteria, show_archived \\ false, opts \\ [])

Search contacts via query. The following search fields are supported

search_salutations(req, criteria, opts \\ [])

Search salutations via query. The following search fields are supported

search_titles(req, criteria, opts \\ [])

Search title via query. The following search fields are supported

Link to this section Types

Link to this type

api_error_type()

@type api_error_type() :: BexioApiClient.Helpers.api_error_type()

Link to this section Functions

Link to this function

fetch_additional_address(req, contact_id, additional_address_id)

@spec fetch_additional_address(
  req :: Req.Request.t(),
  contact_id :: non_neg_integer(),
  additional_address_id :: non_neg_integer()
) :: {:ok, BexioApiClient.Contacts.AdditionalAddress.t()} | api_error_type()

This action fetches a single additional address

Link to this function

fetch_additional_addresses(req, contact_id, opts \\ [])

@spec fetch_additional_addresses(
  req :: Req.Request.t(),
  contact_id :: integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.AdditionalAddress.t()]} | api_error_type()

Fetch a list of additional addresses.

Link to this function

fetch_contact(req, contact_id, show_archived \\ nil)

@spec fetch_contact(
  req :: Req.Request.t(),
  contact_id :: pos_integer(),
  show_archived :: boolean() | nil
) :: {:ok, BexioApiClient.Contacts.Contact.t()} | api_error_type()

This action fetches a single contact

Link to this function

fetch_contact_group(req, contact_group_id)

@spec fetch_contact_group(
  req :: Req.Request.t(),
  contact_group_id :: pos_integer()
) :: {:ok, %{id: integer(), name: String.t()}} | api_error_type()

This action fetches a single contact group

Link to this function

fetch_contact_groups(req, opts \\ [])

@spec fetch_contact_groups(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of contacts groups.

Link to this function

fetch_contact_relation(req, contact_relation_id)

@spec fetch_contact_relation(
  req :: Req.Request.t(),
  contact_relation_id :: pos_integer()
) :: {:ok, BexioApiClient.Contacts.ContactRelation.t()} | api_error_type()

This action fetches a single contact relation

Link to this function

fetch_contact_relations(req, opts \\ [])

@spec fetch_contact_relations(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.ContactRelation.t()]} | api_error_type()

Fetch a list of contacts relations.

Link to this function

fetch_contact_sectors(req, opts \\ [])

@spec fetch_contact_sectors(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of contacts sectors.

Link to this function

fetch_contacts(req, show_archived \\ false, opts \\ [])

@spec fetch_contacts(
  req :: Req.Request.t(),
  show_archived :: boolean(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.Contact.t()]} | api_error_type()

Fetch a list of contacts.

arguments

 Arguments:

  • :opts - paging and ordering options
    • :show_archived - Show archived elements only,
Link to this function

fetch_salutation(req, salutation_id)

@spec fetch_salutation(
  req :: Req.Request.t(),
  salutation_id :: non_neg_integer()
) :: {:ok, %{id: integer(), name: String.t()}} | api_error_type()

This action fetches a single salutation

Link to this function

fetch_salutations(req, opts \\ [])

@spec fetch_salutations(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of additional addresses.

Link to this function

fetch_title(req, title_id)

@spec fetch_title(
  req :: Req.Request.t(),
  title_id :: non_neg_integer()
) :: {:ok, %{id: integer(), name: String.t()}} | api_error_type()

This action fetches a single title

Link to this function

fetch_titles(req, opts \\ [])

@spec fetch_titles(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of titles.

Link to this function

search_additional_addresses(req, contact_id, criteria, opts \\ [])

@spec search_additional_addresses(
  req :: Req.Request.t(),
  contact_id :: integer(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.AdditionalAddress.t()]} | api_error_type()

Search additional addresses via query. The following search fields are supported:

  • name
  • address
  • postcode
  • city
  • country_id
  • subject
Link to this function

search_contact_groups(req, criteria, opts \\ [])

@spec search_contact_groups(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Search contact groups via query. The following search fields are supported:

  • name
Link to this function

search_contact_relations(req, criteria, opts \\ [])

@spec search_contact_relations(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.ContactRelation.t()]} | api_error_type()

Search contacts groups via query. The following search fields are supported:

  • contact_id
  • contact_sub_id
  • updated_at
Link to this function

search_contact_sectors(req, criteria, opts \\ [])

@spec search_contact_sectors(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Search contact sectors via query. The following search fields are supported:

  • name
Link to this function

search_contacts(req, criteria, show_archived \\ false, opts \\ [])

@spec search_contacts(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  show_archived :: boolean(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Contacts.Contact.t()]} | api_error_type()

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

  • id
  • name_1
  • name_2
  • nr
  • address
  • mail
  • mail_second
  • postcode
  • city
  • country_id
  • contact_group_ids
  • contact_type_id
  • updated_at
  • user_id
  • phone_fixed
  • phone_mobile
Link to this function

search_salutations(req, criteria, opts \\ [])

@spec search_salutations(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

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

  • name
Link to this function

search_titles(req, criteria, opts \\ [])

@spec search_titles(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

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

  • name