BexioApiClient.Projects (bexio_api_client v2.0.0)

Bexio API for the projects part of the API.

Summary

Types

api_error_type()

Functions

archive_project(req, project_id)

Archive a project.

create_milestone(req, project_id, milestone)

Create a milestone of a project.

create_project(req, project)

Create a project.

create_work_package(req, project_id, work_package)

Create a work package of a project.

delete_milestone(req, project_id, milestone_id)

Delete a single milestone of a project.

delete_project(req, project_id)

Delete a project.

delete_work_package(req, project_id, package_id)

Delete a single work package of a project.

edit_milestone(req, project_id, milestone)

Edit a single milestone of a project.

edit_project(req, project)

Edit a project.

edit_work_package(req, project_id, work_package)

Edit a single work package of a project.

fetch_milestone(req, project_id, milestone_id)

Fetch a single milestone of a project.

fetch_milestones(req, project_id, opts \\ [])

Fetch a list of milestones of a project.

fetch_project(req, project_id)

Fetch a single project.

fetch_project_states(req)

Fetch a list of project statuses.

fetch_project_types(req, opts \\ [])

Fetch a list of project types.

fetch_projects(req, opts \\ [])

Fetch a list of projects.

fetch_work_package(req, project_id, package_id)

Fetch a single work package of a project.

fetch_work_packages(req, project_id, opts \\ [])

Fetch a list of work packages of a project.

reactivate_project(req, project_id)

Unarchive (reactivate) an archived project.

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

Search projects via query. The following search fields are supported

Types

api_error_type()

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

Functions

archive_project(req, project_id)

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

Archive a project.

create_milestone(req, project_id, milestone)

@spec create_milestone(
  req :: Req.Request.t(),
  project_id :: integer(),
  milestone :: BexioApiClient.Projects.Milestone.t()
) :: {:ok, BexioApiClient.Projects.Milestone.t()} | api_error_type()

Create a milestone of a project.

create_project(req, project)

@spec create_project(
  req :: Req.Request.t(),
  project :: BexioApiClient.Projects.Project.t()
) ::
  {:ok, BexioApiClient.Projects.Project.t()} | api_error_type()

Create a project.

create_work_package(req, project_id, work_package)

@spec create_work_package(
  req :: Req.Request.t(),
  project_id :: integer(),
  work_package :: BexioApiClient.Projects.WorkPackage.t()
) :: {:ok, BexioApiClient.Projects.WorkPackage.t()} | api_error_type()

Create a work package of a project.

delete_milestone(req, project_id, milestone_id)

@spec delete_milestone(
  req :: Req.Request.t(),
  project_id :: integer(),
  milestone_id :: integer()
) ::
  {:ok, boolean()} | api_error_type()

Delete a single milestone of a project.

delete_project(req, project_id)

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

Delete a project.

delete_work_package(req, project_id, package_id)

@spec delete_work_package(
  req :: Req.Request.t(),
  project_id :: integer(),
  package_id :: integer()
) ::
  {:ok, boolean()} | api_error_type()

Delete a single work package of a project.

edit_milestone(req, project_id, milestone)

@spec edit_milestone(
  req :: Req.Request.t(),
  project_id :: integer(),
  milestone :: BexioApiClient.Projects.Milestone.t()
) :: {:ok, BexioApiClient.Projects.Milestone.t()} | api_error_type()

Edit a single milestone of a project.

edit_project(req, project)

@spec edit_project(
  req :: Req.Request.t(),
  project :: BexioApiClient.Projects.Project.t()
) ::
  {:ok, BexioApiClient.Projects.Project.t()} | api_error_type()

Edit a project.

edit_work_package(req, project_id, work_package)

@spec edit_work_package(
  req :: Req.Request.t(),
  project_id :: integer(),
  work_package :: BexioApiClient.Projects.WorkPackage.t()
) :: {:ok, BexioApiClient.Projects.WorkPackage.t()} | api_error_type()

Edit a single work package of a project.

fetch_milestone(req, project_id, milestone_id)

@spec fetch_milestone(
  req :: Req.Request.t(),
  project_id :: integer(),
  milestone_id :: integer()
) ::
  {:ok, BexioApiClient.Projects.Milestone.t()} | api_error_type()

Fetch a single milestone of a project.

fetch_milestones(req, project_id, opts \\ [])

@spec fetch_milestones(
  req :: Req.Request.t(),
  project_id :: integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Projects.Milestone.t()]} | api_error_type()

Fetch a list of milestones of a project.

fetch_project(req, project_id)

@spec fetch_project(req :: Req.Request.t(), project_id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Projects.Project.t()} | api_error_type()

Fetch a single project.

fetch_project_states(req)

@spec fetch_project_states(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Projects.ProjectState.t()]} | api_error_type()

Fetch a list of project statuses.

fetch_project_types(req, opts \\ [])

@spec fetch_project_types(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, [BexioApiClient.Projects.ProjectType.t()]} | api_error_type()

Fetch a list of project types.

fetch_projects(req, opts \\ [])

@spec fetch_projects(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, [BexioApiClient.Projects.Project.t()]} | api_error_type()

Fetch a list of projects.

fetch_work_package(req, project_id, package_id)

@spec fetch_work_package(
  req :: Req.Request.t(),
  project_id :: integer(),
  package_id :: integer()
) ::
  {:ok, BexioApiClient.Projects.WorkPackage.t()} | api_error_type()

Fetch a single work package of a project.

fetch_work_packages(req, project_id, opts \\ [])

@spec fetch_work_packages(
  req :: Req.Request.t(),
  project_id :: integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Projects.WorkPackage.t()]} | api_error_type()

Fetch a list of work packages of a project.

reactivate_project(req, project_id)

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

Unarchive (reactivate) an archived project.

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

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

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

name
contact_id
pr_state_id