bexio_api_client
v0.6.4

BexioApiClient.SearchCriteria (bexio_api_client v0.6.4)

Some older endpoints implement search methods. Searching for these endpoint works by sending a POST request to the resource (e.g.: POST /contact/search or POST /country/search). The search parameters must be provided in the body of the POST request.

Link to this section Summary

Types

t()

One search criteria argument

Functions

equal(field, value)

Creates a = search criteria

greater_equal(field, value)

Creates a >= search criteria

greater_than(field, value)

Creates a > search criteria

less_equal(field, value)

Creates a <= search criteria

less_than(field, value)

Creates a < search criteria

like(field, value)

Creates a like search criteria

nil?(field)

Creates a is_null search criteria

not_equal(field, value)

Creates a != search criteria

not_like(field, value)

Creates a not_like search criteria

not_nil?(field)

Creates a not_null search criteria

not_part_of(field, value)

Creates a not_in search criteria

part_of(field, value)

Creates a in search criteria

sigil_f(field, opts)

Link to this section Types

Link to this type

t()

@type t() :: %BexioApiClient.SearchCriteria{
  criteria:
    :equal
    | :=
    | :!=
    | :not_equal
    | :>
    | :greater_than
    | :<
    | :less_than
    | :>=
    | :greater_equal
    | :<=
    | :less_equal
    | :like
    | :not_like
    | :is_null
    | :not_null
    | :in
    | :not_in,
  field: atom(),
  value: any() | nil
}

One search criteria argument

fields

 Fields:

  • :name - The name of the parameter to look up
  • :criteria - the criteria to fulfill
  • :value - the value to search for

Link to this section Functions

Link to this function

equal(field, value)

@spec equal(atom(), any()) :: t()

Creates a = search criteria

Link to this function

greater_equal(field, value)

@spec greater_equal(atom(), any()) :: t()

Creates a >= search criteria

Link to this function

greater_than(field, value)

@spec greater_than(atom(), any()) :: t()

Creates a > search criteria

Link to this function

less_equal(field, value)

@spec less_equal(atom(), any()) :: t()

Creates a <= search criteria

Link to this function

less_than(field, value)

@spec less_than(atom(), any()) :: t()

Creates a < search criteria

Link to this function

like(field, value)

@spec like(atom(), any()) :: t()

Creates a like search criteria

Link to this function

nil?(field)

@spec nil?(atom()) :: t()

Creates a is_null search criteria

Link to this function

not_equal(field, value)

@spec not_equal(atom(), any()) :: t()

Creates a != search criteria

Link to this function

not_like(field, value)

@spec not_like(atom(), any()) :: t()

Creates a not_like search criteria

Link to this function

not_nil?(field)

@spec not_nil?(atom()) :: t()

Creates a not_null search criteria

Link to this function

not_part_of(field, value)

@spec not_part_of(atom(), list()) :: t()

Creates a not_in search criteria

Link to this function

part_of(field, value)

@spec part_of(atom(), list()) :: t()

Creates a in search criteria

Link to this function

sigil_f(field, opts)

@spec sigil_f(String.t(), Keyword.t()) :: t()