BexioApiClient.GlobalArguments (bexio_api_client v2.0.0)

Copy Markdown

Typespec and helpers for global usable arguments

Summary

Types

offset_arg()

@type offset_arg() :: {:order_by, atom()} | offset_without_order_by_arg()

offset_without_order_by_arg()

@type offset_without_order_by_arg() ::
  {:limit, pos_integer()} | {:offset, non_neg_integer()}

paging_arg()

@type paging_arg() ::
  {:limit, pos_integer()}
  | {:page, non_neg_integer()}
  | {:order, [:asc | :desc] | {:sort, [:atom]}}

Functions

opts_to_query(opts)

@spec opts_to_query([offset_without_order_by_arg() | offset_arg() | paging_arg()]) ::
  keyword()