Rust API client for kimai_client_lib

JSON API for the Kimai time-tracking software. Read our API documentation and download the Open API definition to import into your API client.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.0
• Generator version: 7.13.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named kimai_client_lib and add the following to Cargo.toml under [dependencies]:

kimai_client_lib = { path = "./kimai_client_lib" }

Documentation for API Endpoints

All URIs are relative to http://localhost

AbsenceApi | delete_delete_absence | DELETE /api/absences/{id} | Delete an absence AbsenceApi | delete_delete_public_holiday | DELETE /api/public-holidays/{id} | Delete a public holiday AbsenceApi | delete_delete_public_holiday_group | DELETE /api/public-holidays/group/{id} | Delete a public holiday group AbsenceApi | get_get_absences | GET /api/absences | Returns a collection of absences (sickness, vacation, time-off, other). AbsenceApi | get_get_absences_calendar | GET /api/absences/calendar | Returns a collection of absences (sickness, vacation, time-off, other) for calendar integration. AbsenceApi | get_get_public_holidays | GET /api/public-holidays | Returns a collection of public holidays. AbsenceApi | get_get_public_holidays_calendar | GET /api/public-holidays/calendar | Returns a collection of public holidays for calendar integration. AbsenceApi | get_kimaiplugin_workcontract_api_absence_getabsencetypes | GET /api/absences/types | Returns a collection of absences (sickness, vacation, time-off, other). AbsenceApi | patch_confirm_approval_absence | PATCH /api/absences/{id}/confirm | Confirm an approval request AbsenceApi | patch_reject_approval_absence | PATCH /api/absences/{id}/reject | Reject an approval request AbsenceApi | patch_request_approval_absence | PATCH /api/absences/{id}/request | Request an approval ActionsApi | get_get_activity_actions | GET /api/actions/activity/{id}/{view}/{locale} | Get all item actions for the given Activity [for internal use] ActionsApi | get_get_customer_actions | GET /api/actions/customer/{id}/{view}/{locale} | Get all item actions for the given Customer [for internal use] ActionsApi | get_get_project_actions | GET /api/actions/project/{id}/{view}/{locale} | Get all item actions for the given Project [for internal use] ActionsApi | get_get_timesheet_actions | GET /api/actions/timesheet/{id}/{view}/{locale} | Get all item actions for the given Timesheet [for internal use] ActivityApi | delete_delete_activity | DELETE /api/activities/{id} | Delete an existing activity ActivityApi | delete_delete_activity_rate | DELETE /api/activities/{id}/rates/{rateId} | Deletes one rate for an activity ActivityApi | get_get_activities | GET /api/activities | Returns a collection of activities (which are visible to the user) ActivityApi | get_get_activity | GET /api/activities/{id} | Returns one activity ActivityApi | get_get_activity_rates | GET /api/activities/{id}/rates | Returns a collection of all rates for one activity ActivityApi | patch_app_api_activity_meta | PATCH /api/activities/{id}/meta | Sets the value of a meta-field for an existing activity ActivityApi | patch_patch_activity | PATCH /api/activities/{id} | Update an existing activity ActivityApi | post_post_activity | POST /api/activities | Creates a new activity ActivityApi | post_post_activity_rate | POST /api/activities/{id}/rates | Adds a new rate to an activity CustomerApi | delete_delete_customer | DELETE /api/customers/{id} | Delete an existing customer CustomerApi | delete_delete_customer_rate | DELETE /api/customers/{id}/rates/{rateId} | Deletes one rate for a customer CustomerApi | get_get_customer | GET /api/customers/{id} | Returns one customer CustomerApi | get_get_customer_rates | GET /api/customers/{id}/rates | Returns a collection of all rates for one customer CustomerApi | get_get_customers | GET /api/customers | Returns a collection of customers (which are visible to the user) CustomerApi | patch_app_api_customer_meta | PATCH /api/customers/{id}/meta | Sets the value of a meta-field for an existing customer CustomerApi | patch_patch_customer | PATCH /api/customers/{id} | Update an existing customer CustomerApi | post_post_customer | POST /api/customers | Creates a new customer CustomerApi | post_post_customer_rate | POST /api/customers/{id}/rates | Adds a new rate to a customer DefaultApi | get_app_api_configuration_colorconfig | GET /api/config/colors | Returns the configured color codes and names DefaultApi | get_app_api_configuration_timesheetconfig | GET /api/config/timesheet | Returns the timesheet configuration DefaultApi | get_app_api_status_ping | GET /api/ping | A testing route for the API DefaultApi | get_app_api_status_plugin | GET /api/plugins | Returns information about installed Plugins DefaultApi | get_app_api_status_version | GET /api/version | Returns information about the Kimai release DefaultApi | post_cloud_last_read_news_set | POST /api/cloud/news_date | Sets the last-read-news date on a user. ExpenseApi | delete_delete_expense | DELETE /api/expenses/{id} | Delete an existing expense record ExpenseApi | get_get_expense | GET /api/expenses/{id} | Returns one expense ExpenseApi | get_get_expense_categories | GET /api/expenses/categories | Get all visible expense categories (requires "manage_expense_category" permission) ExpenseApi | get_get_expenses | GET /api/expenses | Returns a collection of expenses ExpenseApi | patch_duplicate_expense | PATCH /api/expenses/{id}/duplicate | Duplicates an existing expense record ExpenseApi | patch_kimaiplugin_expenses_api_expense_meta | PATCH /api/expenses/{id}/meta | Sets the value of a meta-field for an existing expense ExpenseApi | patch_patch_expense | PATCH /api/expenses/{id} | Update an existing expense ExpenseApi | post_post_expense | POST /api/expenses | Creates a new expense InvoiceApi | get_get_invoice | GET /api/invoices/{id} | Returns one invoice. InvoiceApi | get_get_invoices | GET /api/invoices | Returns a paginated collection of invoices. KioskApi | get_api_kiosk_get_userauth_by_user | GET /api/kiosk/codes/{id} | Returns one UserAuthCodes entity KioskApi | get_api_kiosk_get_userauths | GET /api/kiosk/codes | Returns a collection of UserAuthCodes objects MetaFieldApi | get_kimaiplugin_metafields_api_metafields_cget | GET /api/metafields | Returns a collection of meta-fields ProjectApi | delete_delete_project | DELETE /api/projects/{id} | Delete an existing project ProjectApi | delete_delete_project_rate | DELETE /api/projects/{id}/rates/{rateId} | Deletes one rate for a project ProjectApi | get_get_project | GET /api/projects/{id} | Returns one project ProjectApi | get_get_project_rates | GET /api/projects/{id}/rates | Returns a collection of all rates for one project ProjectApi | get_get_projects | GET /api/projects | Returns a collection of projects (which are visible to the user) ProjectApi | patch_app_api_project_meta | PATCH /api/projects/{id}/meta | Sets the value of a meta-field for an existing project ProjectApi | patch_patch_project | PATCH /api/projects/{id} | Update an existing project ProjectApi | post_post_project | POST /api/projects | Creates a new project ProjectApi | post_post_project_rate | POST /api/projects/{id}/rates | Adds a new rate to a project TagApi | delete_delete_tag | DELETE /api/tags/{id} | Delete a tag TagApi | get_get_tags | GET /api/tags | Deprecated: Fetch tags by filter as string collection TagApi | get_get_tags_full | GET /api/tags/find | Fetch tags by filter (as full entities) TagApi | post_post_tag | POST /api/tags | Creates a new tag TaskApi | delete_delete_task | DELETE /api/tasks/{id} | Delete an existing task record TaskApi | get_get_task | GET /api/tasks/{id} | Returns one task TaskApi | get_get_tasks | GET /api/tasks | Returns a collection of tasks TaskApi | get_tasks_timesheets | GET /api/tasks/{id}/timesheets | Returns a collection of timesheets for one task TaskApi | patch_assign_task | PATCH /api/tasks/{id}/assign | Assign a task to the current user TaskApi | patch_close_task | PATCH /api/tasks/{id}/close | Close a task for the current user TaskApi | patch_kimaiplugin_taskmanagement_api_task_meta | PATCH /api/tasks/{id}/meta | Sets the value of a meta-field for an existing task TaskApi | patch_log_task | PATCH /api/tasks/{id}/log | Logs work for a task record TaskApi | patch_patch_task | PATCH /api/tasks/{id} | Update an existing task TaskApi | patch_reopen_task | PATCH /api/tasks/{id}/reopen | Reopens a task for the current user TaskApi | patch_start_task | PATCH /api/tasks/{id}/start | Start working on a task TaskApi | patch_stop_task | PATCH /api/tasks/{id}/stop | Stops a task record for the current user TaskApi | patch_unassign_task | PATCH /api/tasks/{id}/unassign | Unassign a task from the current user TaskApi | post_post_task | POST /api/tasks | Creates a new Task TeamApi | delete_delete_team | DELETE /api/teams/{id} | Delete a team TeamApi | delete_delete_team_activity | DELETE /api/teams/{id}/activities/{activityId} | Revokes access for an activity from a team TeamApi | delete_delete_team_customer | DELETE /api/teams/{id}/customers/{customerId} | Revokes access for a customer from a team TeamApi | delete_delete_team_member | DELETE /api/teams/{id}/members/{userId} | Removes a member from the team TeamApi | delete_delete_team_project | DELETE /api/teams/{id}/projects/{projectId} | Revokes access for a project from a team TeamApi | get_get_team | GET /api/teams/{id} | Returns one team TeamApi | get_get_teams | GET /api/teams | Fetch all existing teams (which are visible to the user) TeamApi | patch_patch_team | PATCH /api/teams/{id} | Update an existing team TeamApi | post_post_team | POST /api/teams | Creates a new team TeamApi | post_post_team_activity | POST /api/teams/{id}/activities/{activityId} | Grant the team access to an activity TeamApi | post_post_team_customer | POST /api/teams/{id}/customers/{customerId} | Grant the team access to a customer TeamApi | post_post_team_member | POST /api/teams/{id}/members/{userId} | Add a new member to a team TeamApi | post_post_team_project | POST /api/teams/{id}/projects/{projectId} | Grant the team access to a project TimesheetApi | delete_delete_timesheet | DELETE /api/timesheets/{id} | Delete an existing timesheet record TimesheetApi | get_active_timesheet | GET /api/timesheets/active | Returns the collection of active timesheet records TimesheetApi | get_get_timesheet | GET /api/timesheets/{id} | Returns one timesheet record TimesheetApi | get_get_timesheets | GET /api/timesheets | Returns a collection of timesheet records (which are visible to the user) TimesheetApi | get_recent_timesheet | GET /api/timesheets/recent | Returns the collection of recent user activities TimesheetApi | get_restart_timesheet_get | GET /api/timesheets/{id}/restart | Restarts a previously stopped timesheet record for the current user TimesheetApi | get_stop_timesheet_get | GET /api/timesheets/{id}/stop | Stops an active timesheet record. TimesheetApi | patch_app_api_timesheet_meta | PATCH /api/timesheets/{id}/meta | Sets the value of a meta-field for an existing timesheet. TimesheetApi | patch_duplicate_timesheet | PATCH /api/timesheets/{id}/duplicate | Duplicates an existing timesheet record TimesheetApi | patch_export_timesheet | PATCH /api/timesheets/{id}/export | Switch the export state of a timesheet record to (un-)lock it TimesheetApi | patch_patch_timesheet | PATCH /api/timesheets/{id} | Update an existing timesheet record TimesheetApi | patch_restart_timesheet | PATCH /api/timesheets/{id}/restart | Restarts a previously stopped timesheet record for the current user TimesheetApi | patch_stop_timesheet | PATCH /api/timesheets/{id}/stop | Stops an active timesheet record. TimesheetApi | post_post_timesheet | POST /api/timesheets | Creates a new timesheet record UserApi | delete_delete_api_token | DELETE /api/users/api-token/{id} | Delete an API token for the current user UserApi | get_get_user | GET /api/users/{id} | Return one user entity UserApi | get_get_users | GET /api/users | Returns the collection of users (which are visible to the user) UserApi | get_me_user | GET /api/users/me | Return the current user entity UserApi | patch_patch_user | PATCH /api/users/{id} | Update an existing user UserApi | post_post_user | POST /api/users | Creates a new user

Documentation For Models

• Absence

• Activity

• ActivityCollection

• ActivityEditForm

• ActivityEntity

• ActivityExpanded

• ActivityMeta

• ActivityRate

• ActivityRateForm

• CalendarEvent

• Customer

• CustomerCollection

• CustomerEditForm

• CustomerEntity

• CustomerMeta

• CustomerRate

• CustomerRateForm

• ExpenseCategory

• ExpenseEditForm

• ExpenseEntity

• ExpenseMeta

• GetRestartTimesheetGetRequest

• Invoice

• InvoiceCollection

• InvoiceMeta

• MetaFieldRule

• PageAction

• PatchKimaipluginExpensesApiExpenseMetaRequest

• Plugin

• Project

• ProjectCollection

• ProjectEditForm

• ProjectEntity

• ProjectExpanded

• ProjectMeta

• ProjectRate

• ProjectRateForm

• PublicHoliday

• PublicHolidayGroup

• TagEditForm

• TagEntity

• Task

• TaskEditForm

• TaskLogWorkForm

• TaskMeta

• Team

• TeamCollection

• TeamEditForm

• TeamEditFormMembersInner

• TeamMember

• TeamMembership

• TimesheetCollection

• TimesheetCollectionExpanded

• TimesheetConfig

• TimesheetEditForm

• TimesheetEntity

• TimesheetExpanded

• TimesheetMeta

• User

• UserAuth

• UserAuthCodes

• UserCollection

• UserCreateForm

• UserEditForm

• UserEntity

• UserPreference

• Version

To get access to the crate's generated documentation, use:

cargo doc --open

Author