bexio_api_client
v0.6.4

BexioApiClient.Files (bexio_api_client v0.6.4)

Bexio API for the files part of the API

Link to this section Summary

Types

api_error_type()

Functions

download_file(req, id)

Download file (original content).

fetch_file(req, id)

Fetch single file.

fetch_files(req, opts \\ [])

Fetch a list of files.

preview_file(req, id)

Download file (original content).

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

Search files 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

download_file(req, id)

@spec download_file(
  req :: Req.Request.t(),
  id :: non_neg_integer()
) :: {:ok, {String.t(), any()}} | api_error_type()

Download file (original content).

Link to this function

fetch_file(req, id)

@spec fetch_file(
  req :: Req.Request.t(),
  id :: non_neg_integer()
) :: {:ok, BexioApiClient.Files.File.t()} | api_error_type()

Fetch single file.

Link to this function

fetch_files(req, opts \\ [])

@spec fetch_files(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Files.File.t()]} | api_error_type()

Fetch a list of files.

Link to this function

preview_file(req, id)

@spec preview_file(
  req :: Req.Request.t(),
  id :: non_neg_integer()
) :: {:ok, {String.t(), any()}} | api_error_type()

Download file (original content).

Link to this function

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

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

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

  • id
  • uuid
  • created_at
  • name
  • extension
  • size_in_bytes
  • mime_type
  • user_id
  • archived?
  • source_id