BexioApiClient.Contacts (bexio_api_client v2.0.0)

Copy Markdown

Bexio API for the contacts part of the API.

Summary

Types

api_error_type()

Functions

bulk_create_contacts(req, contacts)

Bulk create multiple contacts in one request.

create_additional_address(req, contact_id, additional_address)

Create an additional address for a contact.

create_contact(req, contact)

Create a contact.

create_contact_group(req, name)

Create a contact group.

create_contact_relation(req, contact_relation)

Create a contact relation.

create_salutation(req, name)

Create a salutation.

create_title(req, name)

Create a title.

delete_additional_address(req, contact_id, additional_address_id)

Delete an additional address of a contact.

delete_contact(req, contact_id)

Delete a contact.

delete_contact_group(req, contact_group_id)

Delete a contact group.

delete_contact_relation(req, contact_relation_id)

Delete a contact relation.

delete_salutation(req, salutation_id)

Delete a salutation.

delete_title(req, title_id)

Delete a title.

edit_additional_address(req, contact_id, additional_address)

Edit an additional address of a contact.

edit_contact(req, contact)

Edit a contact.

edit_contact_group(req, contact_group_id, name)

Edit a contact group.

edit_contact_relation(req, contact_relation)

Edit a contact relation.

edit_salutation(req, salutation_id, name)

Edit a salutation.

edit_title(req, title_id, name)

Edit a title.

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.

restore_contact(req, contact_id)

Restore an archived contact.

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

Types

api_error_type()

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

Functions

bulk_create_contacts(req, contacts)

@spec bulk_create_contacts(
  req :: Req.Request.t(),
  contacts :: [BexioApiClient.Contacts.Contact.t()]
) ::
  {:ok, [BexioApiClient.Contacts.Contact.t()]} | api_error_type()

Bulk create multiple contacts in one request.

create_additional_address(req, contact_id, additional_address)

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

Create an additional address for a contact.

create_contact(req, contact)

@spec create_contact(
  req :: Req.Request.t(),
  contact :: BexioApiClient.Contacts.Contact.t()
) ::
  {:ok, BexioApiClient.Contacts.Contact.t()} | api_error_type()

Create a contact.

create_contact_group(req, name)

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

Create a contact group.

create_contact_relation(req, contact_relation)

@spec create_contact_relation(
  req :: Req.Request.t(),
  contact_relation :: BexioApiClient.Contacts.ContactRelation.t()
) :: {:ok, BexioApiClient.Contacts.ContactRelation.t()} | api_error_type()

Create a contact relation.

create_salutation(req, name)

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

Create a salutation.

create_title(req, name)

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

Create a title.

delete_additional_address(req, contact_id, additional_address_id)

@spec delete_additional_address(
  req :: Req.Request.t(),
  contact_id :: non_neg_integer(),
  additional_address_id :: non_neg_integer()
) :: {:ok, boolean()} | api_error_type()

Delete an additional address of a contact.

delete_contact(req, contact_id)

@spec delete_contact(req :: Req.Request.t(), contact_id :: non_neg_integer()) ::
  {:ok, boolean()} | api_error_type()

Delete a contact.

delete_contact_group(req, contact_group_id)

@spec delete_contact_group(
  req :: Req.Request.t(),
  contact_group_id :: non_neg_integer()
) ::
  {:ok, boolean()} | api_error_type()

Delete a contact group.

delete_contact_relation(req, contact_relation_id)

@spec delete_contact_relation(
  req :: Req.Request.t(),
  contact_relation_id :: non_neg_integer()
) ::
  {:ok, boolean()} | api_error_type()

Delete a contact relation.

delete_salutation(req, salutation_id)

@spec delete_salutation(req :: Req.Request.t(), salutation_id :: non_neg_integer()) ::
  {:ok, boolean()} | api_error_type()

Delete a salutation.

delete_title(req, title_id)

@spec delete_title(req :: Req.Request.t(), title_id :: non_neg_integer()) ::
  {:ok, boolean()} | api_error_type()

Delete a title.

edit_additional_address(req, contact_id, additional_address)

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

Edit an additional address of a contact.

edit_contact(req, contact)

@spec edit_contact(
  req :: Req.Request.t(),
  contact :: BexioApiClient.Contacts.Contact.t()
) ::
  {:ok, BexioApiClient.Contacts.Contact.t()} | api_error_type()

Edit a contact.

edit_contact_group(req, contact_group_id, name)

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

Edit a contact group.

edit_contact_relation(req, contact_relation)

@spec edit_contact_relation(
  req :: Req.Request.t(),
  contact_relation :: BexioApiClient.Contacts.ContactRelation.t()
) :: {:ok, BexioApiClient.Contacts.ContactRelation.t()} | api_error_type()

Edit a contact relation.

edit_salutation(req, salutation_id, name)

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

Edit a salutation.

edit_title(req, title_id, name)

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

Edit a title.

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

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.

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

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

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.

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

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.

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.

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:

  • :opts - paging and ordering options
    • :show_archived - Show archived elements only,

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

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.

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

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.

restore_contact(req, contact_id)

@spec restore_contact(req :: Req.Request.t(), contact_id :: non_neg_integer()) ::
  {:ok, boolean()} | api_error_type()

Restore an archived contact.

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

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

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

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

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

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

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