aiorentman 0.2.0__tar.gz

aiorentman-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daan Vervacke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aiorentman-0.2.0/PKG-INFO

@@ -0,0 +1,344 @@
+Metadata-Version: 2.4
+Name: aiorentman
+Version: 0.2.0
+Summary: Unofficial asynchronous Python library to interact with the Rentman API
+Keywords: rentman,rental,equipment,materials,rfid,serial-numbers,api,asyncio,aiohttp,home-assistant
+Author: Daan Vervacke
+Author-email: Daan Vervacke <daan.vervacke@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Dist: aiohttp>=3.14.3
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/DaanVervacke/aiorentman
+Project-URL: Repository, https://github.com/DaanVervacke/aiorentman
+Project-URL: Issues, https://github.com/DaanVervacke/aiorentman/issues
+Project-URL: Changelog, https://github.com/DaanVervacke/aiorentman/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# aiorentman
+
+[![Check](https://github.com/DaanVervacke/aiorentman/actions/workflows/check.yml/badge.svg)](https://github.com/DaanVervacke/aiorentman/actions/workflows/check.yml)
+[![PyPI version](https://img.shields.io/pypi/v/aiorentman.svg)](https://pypi.org/project/aiorentman/)
+[![Python versions](https://img.shields.io/pypi/pyversions/aiorentman.svg)](https://pypi.org/project/aiorentman/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Unofficial asynchronous Python library to interact with the Rentman API. Requires Python >= 3.14.
+
+This is a client for a documented public API, but it is not affiliated with or endorsed by Rentman B.V. Rentman runs one rolling API version and migrates integrations automatically, so the library pins its contract to the OpenAPI document it ships with and validates every endpoint against it.
+
+## Install
+
+```bash
+pip install aiorentman
+```
+
+## Scope
+
+The library covers the resources an RFID and materials project needs. Reads cover every documented GET path:
+
+| Resource | List | Iterate | Get |
+| --- | --- | --- | --- |
+| Equipment (materials) | `async_list_equipment` | `async_iter_equipment` | `async_get_equipment` |
+| Serial numbers | `async_list_serial_numbers` | `async_iter_serial_numbers` | `async_get_serial_number` |
+| Serial numbers of a material | `async_list_serial_numbers_of_equipment` | `async_iter_serial_numbers_of_equipment` | |
+| Actual content | `async_list_actual_content` | `async_iter_actual_content` | `async_get_actual_content` |
+| Actual content of a serial | `async_list_actual_content_of_serial_number` | `async_iter_actual_content_of_serial_number` | |
+| Assigned serials | `async_list_equipment_assigned_serials` | `async_iter_equipment_assigned_serials` | `async_get_equipment_assigned_serial` |
+| Assigned serials of a serial | `async_list_equipment_assigned_serials_of_serial_number` | `async_iter_equipment_assigned_serials_of_serial_number` | |
+| Set content | `async_list_equipment_set_content` | `async_iter_equipment_set_content` | `async_get_equipment_set_content` |
+| Set content of a material | `async_list_equipment_set_content_of_equipment` | `async_iter_equipment_set_content_of_equipment` | |
+| Folders | `async_list_folders` | `async_iter_folders` | `async_get_folder` |
+| Stock locations | `async_list_stock_locations` | `async_iter_stock_locations` | `async_get_stock_location` |
+| Warehouse statuses | `async_list_warehouse_statuses` | `async_iter_warehouse_statuses` | `async_get_warehouse_status` |
+| Statuses | `async_list_statuses` | `async_iter_statuses` | `async_get_status` |
+| Stock movements | `async_list_stock_movements` | `async_iter_stock_movements` | `async_get_stock_movement` |
+| Stock movements of a material | `async_list_stock_movements_of_equipment` | `async_iter_stock_movements_of_equipment` | |
+| Repairs | `async_list_repairs` | `async_iter_repairs` | `async_get_repair` |
+| Repairs of a material | `async_list_repairs_of_equipment` | `async_iter_repairs_of_equipment` | |
+| Projects | `async_list_projects` | `async_iter_projects` | `async_get_project` |
+| Subprojects | `async_list_subprojects` | `async_iter_subprojects` | `async_get_subproject` |
+| Subprojects of a project | `async_list_subprojects_of_project` | `async_iter_subprojects_of_project` | |
+| Project equipment | `async_list_project_equipment` | `async_iter_project_equipment` | `async_get_project_equipment` |
+| Project equipment of a project | `async_list_project_equipment_of_project` | `async_iter_project_equipment_of_project` | |
+| Project equipment of a subproject | `async_list_project_equipment_of_subproject` | `async_iter_project_equipment_of_subproject` | |
+| Accessories | `async_list_accessories` | `async_iter_accessories` | `async_get_accessory` |
+| Accessories of a material | `async_list_accessories_of_equipment` | `async_iter_accessories_of_equipment` | |
+| Alternatives | `async_list_alternatives` | `async_iter_alternatives` | `async_get_alternative` |
+| Alternatives of a material | `async_list_alternatives_of_equipment` | `async_iter_alternatives_of_equipment` | |
+| Suppliers | `async_list_suppliers` | `async_iter_suppliers` | `async_get_supplier` |
+| Suppliers of a material | `async_list_suppliers_of_equipment` | `async_iter_suppliers_of_equipment` | |
+| Vehicles | `async_list_vehicles` | `async_iter_vehicles` | `async_get_vehicle` |
+| Vehicles of a stock location | `async_list_vehicles_of_stock_location` | `async_iter_vehicles_of_stock_location` | |
+| Extra input fields | `async_list_extra_input_fields` | `async_iter_extra_input_fields` | `async_get_extra_input_field` |
+| Project statuses | `async_list_project_statuses` | `async_iter_project_statuses` | `async_get_project_status` |
+| Project types | `async_list_project_types` | `async_iter_project_types` | `async_get_project_type` |
+| Project function groups | `async_list_project_function_groups` | `async_iter_project_function_groups` | `async_get_project_function_group` |
+| Function groups of a project | `async_list_project_function_groups_of_project` | `async_iter_project_function_groups_of_project` | |
+| Function groups of a subproject | `async_list_project_function_groups_of_subproject` | `async_iter_project_function_groups_of_subproject` | |
+| Project functions | `async_list_project_functions` | `async_iter_project_functions` | `async_get_project_function` |
+| Functions of a project | `async_list_project_functions_of_project` | `async_iter_project_functions_of_project` | |
+| Functions of a function group | `async_list_project_functions_of_project_function_group` | `async_iter_project_functions_of_project_function_group` | |
+| Project crew | `async_list_project_crew` | `async_iter_project_crew` | `async_get_project_crew` |
+| Crew of a project | `async_list_project_crew_of_project` | `async_iter_project_crew_of_project` | |
+| Crew of a subproject | `async_list_project_crew_of_subproject` | `async_iter_project_crew_of_subproject` | |
+| Crew of a project function | `async_list_project_crew_of_project_function` | `async_iter_project_crew_of_project_function` | |
+| Project vehicles | `async_list_project_vehicles` | `async_iter_project_vehicles` | `async_get_project_vehicle` |
+| Vehicles of a project | `async_list_project_vehicles_of_project` | `async_iter_project_vehicles_of_project` | |
+| Vehicles of a subproject | `async_list_project_vehicles_of_subproject` | `async_iter_project_vehicles_of_subproject` | |
+| Vehicles of a project function | `async_list_project_vehicles_of_project_function` | `async_iter_project_vehicles_of_project_function` | |
+| Project equipment groups | `async_list_project_equipment_groups` | `async_iter_project_equipment_groups` | `async_get_project_equipment_group` |
+| Equipment groups of a project | `async_list_project_equipment_groups_of_project` | `async_iter_project_equipment_groups_of_project` | |
+| Equipment groups of a subproject | `async_list_project_equipment_groups_of_subproject` | `async_iter_project_equipment_groups_of_subproject` | |
+| Project equipment of an equipment group | `async_list_project_equipment_of_project_equipment_group` | `async_iter_project_equipment_of_project_equipment_group` | |
+| Project costs | `async_list_project_costs` | `async_iter_project_costs` | `async_get_project_cost` |
+| Costs of a project | `async_list_project_costs_of_project` | `async_iter_project_costs_of_project` | |
+| Project requests | `async_list_project_requests` | `async_iter_project_requests` | `async_get_project_request` |
+| Project request equipment | `async_list_project_request_equipment` | `async_iter_project_request_equipment` | `async_get_project_request_equipment` |
+| Request equipment of a project request | `async_list_project_request_equipment_of_project_request` | `async_iter_project_request_equipment_of_project_request` | |
+| Quotes | `async_list_quotes` | `async_iter_quotes` | `async_get_quote` |
+| Quotes of a project | `async_list_quotes_of_project` | `async_iter_quotes_of_project` | |
+| Invoice lines of a quote | `async_list_invoice_lines_of_quote` | `async_iter_invoice_lines_of_quote` | |
+| Contracts | `async_list_contracts` | `async_iter_contracts` | `async_get_contract` |
+| Contracts of a project | `async_list_contracts_of_project` | `async_iter_contracts_of_project` | |
+| Invoices | `async_list_invoices` | `async_iter_invoices` | `async_get_invoice` |
+| Invoice lines of an invoice | `async_list_invoice_lines_of_invoice` | `async_iter_invoice_lines_of_invoice` | |
+| Payments of an invoice | `async_list_payments_of_invoice` | `async_iter_payments_of_invoice` | |
+| Invoice lines | `async_list_invoice_lines` | `async_iter_invoice_lines` | `async_get_invoice_line` |
+| Payments | `async_list_payments` | `async_iter_payments` | `async_get_payment` |
+| Ledger codes | `async_list_ledger_codes` | `async_iter_ledger_codes` | `async_get_ledger_code` |
+| Tax classes | `async_list_tax_classes` | `async_iter_tax_classes` | `async_get_tax_class` |
+| Subrentals | `async_list_subrentals` | `async_iter_subrentals` | `async_get_subrental` |
+| Subrental equipment | `async_list_subrental_equipment` | `async_iter_subrental_equipment` | `async_get_subrental_equipment` |
+| Subrental equipment of a subrental | `async_list_subrental_equipment_of_subrental` | `async_iter_subrental_equipment_of_subrental` | |
+| Subrental equipment of a group | `async_list_subrental_equipment_of_subrental_equipment_group` | `async_iter_subrental_equipment_of_subrental_equipment_group` | |
+| Subrental equipment groups | `async_list_subrental_equipment_groups` | `async_iter_subrental_equipment_groups` | `async_get_subrental_equipment_group` |
+| Equipment groups of a subrental | `async_list_subrental_equipment_groups_of_subrental` | `async_iter_subrental_equipment_groups_of_subrental` | |
+| Purchase orders | `async_list_purchase_orders` | `async_iter_purchase_orders` | `async_get_purchase_order` |
+| Invoice lines of a purchase order | `async_list_invoice_lines_of_purchase_order` | `async_iter_invoice_lines_of_purchase_order` | |
+| Purchase order costs | `async_list_purchase_order_costs` | `async_iter_purchase_order_costs` | `async_get_purchase_order_cost` |
+| Costs of a purchase order | `async_list_purchase_order_costs_of_purchase_order` | `async_iter_purchase_order_costs_of_purchase_order` | |
+| Purchase order global costs | `async_list_purchase_order_global_costs` | `async_iter_purchase_order_global_costs` | `async_get_purchase_order_global_cost` |
+| Global costs of a purchase order | `async_list_purchase_order_global_costs_of_purchase_order` | `async_iter_purchase_order_global_costs_of_purchase_order` | |
+| Crew | `async_list_crew` | `async_iter_crew` | `async_get_crew` |
+| Appointments of a crew member | `async_list_appointments_of_crew` | `async_iter_appointments_of_crew` | |
+| Crew availability | `async_list_crew_availability` | `async_iter_crew_availability` | `async_get_crew_availability` |
+| Availability of a crew member | `async_list_crew_availability_of_crew` | `async_iter_crew_availability_of_crew` | |
+| Crew rates | `async_list_crew_rates` | `async_iter_crew_rates` | `async_get_crew_rate` |
+| Rates of a crew member | `async_list_crew_rates_of_crew` | `async_iter_crew_rates_of_crew` | |
+| Invitations | `async_list_invitations` | `async_iter_invitations` | `async_get_invitation` |
+| Invitations of a crew member | `async_list_invitations_of_crew` | `async_iter_invitations_of_crew` | |
+| Appointments | `async_list_appointments` | `async_iter_appointments` | `async_get_appointment` |
+| Appointment crew | `async_list_appointment_crew` | `async_iter_appointment_crew` | `async_get_appointment_crew` |
+| Crew of an appointment | `async_list_appointment_crew_of_appointment` | `async_iter_appointment_crew_of_appointment` | |
+| Time registrations | `async_list_time_registrations` | `async_iter_time_registrations` | `async_get_time_registration` |
+| Time registration activities | `async_list_time_registration_activities` | `async_iter_time_registration_activities` | `async_get_time_registration_activity` |
+| Activities of a time registration | `async_list_time_registration_activities_of_time_registration` | `async_iter_time_registration_activities_of_time_registration` | |
+| Leave requests | `async_list_leave_requests` | `async_iter_leave_requests` | `async_get_leave_request` |
+| Time registrations of a leave request | `async_list_time_registrations_of_leave_request` | `async_iter_time_registrations_of_leave_request` | |
+| Leave mutations | `async_list_leave_mutations` | `async_iter_leave_mutations` | `async_get_leave_mutation` |
+| Leave types | `async_list_leave_types` | `async_iter_leave_types` | `async_get_leave_type` |
+| Contacts | `async_list_contacts` | `async_iter_contacts` | `async_get_contact` |
+| Contact persons | `async_list_contact_persons` | `async_iter_contact_persons` | `async_get_contact_person` |
+| Contact persons of a contact | `async_list_contact_persons_of_contact` | `async_iter_contact_persons_of_contact` | |
+| Tasks | `async_list_tasks` | `async_iter_tasks` | `async_get_tasks` |
+| Subtasks | `async_list_subtasks` | `async_iter_subtasks` | `async_get_subtasks` |
+| Task assignments | `async_list_task_assignments` | `async_iter_task_assignments` | `async_get_task_assignments` |
+| Task statuses | `async_list_task_statuses` | `async_iter_task_statuses` | `async_get_task_statuses` |
+| Files | `async_list_files` | `async_iter_files` | `async_get_files` |
+| File folders | `async_list_file_folders` | `async_iter_file_folders` | `async_get_file_folders` |
+| Subtasks of a task | `async_list_subtasks_of_task` | `async_iter_subtasks_of_task` |  |
+| Task assignments of a task | `async_list_task_assignments_of_task` | `async_iter_task_assignments_of_task` |  |
+| Files of a task | `async_list_files_of_task` | `async_iter_files_of_task` |  |
+| File folders of a task | `async_list_file_folders_of_task` | `async_iter_file_folders_of_task` |  |
+| Tasks of a contact person | `async_list_tasks_of_contact_person` | `async_iter_tasks_of_contact_person` |  |
+| Tasks of a contact | `async_list_tasks_of_contact` | `async_iter_tasks_of_contact` |  |
+| Tasks of a crew member | `async_list_tasks_of_crew` | `async_iter_tasks_of_crew` |  |
+| Tasks of a material | `async_list_tasks_of_equipment` | `async_iter_tasks_of_equipment` |  |
+| Tasks of an invoice | `async_list_tasks_of_invoice` | `async_iter_tasks_of_invoice` |  |
+| Tasks of a project | `async_list_tasks_of_project` | `async_iter_tasks_of_project` |  |
+| Tasks of a purchase order | `async_list_tasks_of_purchase_order` | `async_iter_tasks_of_purchase_order` |  |
+| Tasks of a quote | `async_list_tasks_of_quote` | `async_iter_tasks_of_quote` |  |
+| Tasks of a repair | `async_list_tasks_of_repair` | `async_iter_tasks_of_repair` |  |
+| Tasks of a serial number | `async_list_tasks_of_serial_number` | `async_iter_tasks_of_serial_number` |  |
+| Tasks of a subrental | `async_list_tasks_of_subrental` | `async_iter_tasks_of_subrental` |  |
+| Tasks of a vehicle | `async_list_tasks_of_vehicle` | `async_iter_tasks_of_vehicle` |  |
+| Tasks of a supplier | `async_list_tasks_of_supplier` | `async_iter_tasks_of_supplier` |  |
+| Files of a contact person | `async_list_files_of_contact_person` | `async_iter_files_of_contact_person` |  |
+| Files of a contact | `async_list_files_of_contact` | `async_iter_files_of_contact` |  |
+| Files of a crew member | `async_list_files_of_crew` | `async_iter_files_of_crew` |  |
+| Files of a material | `async_list_files_of_equipment` | `async_iter_files_of_equipment` |  |
+| Files of an invoice | `async_list_files_of_invoice` | `async_iter_files_of_invoice` |  |
+| Files of a project | `async_list_files_of_project` | `async_iter_files_of_project` |  |
+| Files of a purchase order | `async_list_files_of_purchase_order` | `async_iter_files_of_purchase_order` |  |
+| Files of a quote | `async_list_files_of_quote` | `async_iter_files_of_quote` |  |
+| Files of a repair | `async_list_files_of_repair` | `async_iter_files_of_repair` |  |
+| Files of a serial number | `async_list_files_of_serial_number` | `async_iter_files_of_serial_number` |  |
+| Files of a subrental | `async_list_files_of_subrental` | `async_iter_files_of_subrental` |  |
+| Files of a time registration | `async_list_files_of_time_registration` | `async_iter_files_of_time_registration` |  |
+| Files of a vehicle | `async_list_files_of_vehicle` | `async_iter_files_of_vehicle` |  |
+| Files of a supplier | `async_list_files_of_supplier` | `async_iter_files_of_supplier` |  |
+| File folders of a contact person | `async_list_file_folders_of_contact_person` | `async_iter_file_folders_of_contact_person` |  |
+| File folders of a contact | `async_list_file_folders_of_contact` | `async_iter_file_folders_of_contact` |  |
+| File folders of a crew member | `async_list_file_folders_of_crew` | `async_iter_file_folders_of_crew` |  |
+| File folders of a material | `async_list_file_folders_of_equipment` | `async_iter_file_folders_of_equipment` |  |
+| File folders of a project | `async_list_file_folders_of_project` | `async_iter_file_folders_of_project` |  |
+| File folders of a purchase order | `async_list_file_folders_of_purchase_order` | `async_iter_file_folders_of_purchase_order` |  |
+| File folders of a repair | `async_list_file_folders_of_repair` | `async_iter_file_folders_of_repair` |  |
+| File folders of a serial number | `async_list_file_folders_of_serial_number` | `async_iter_file_folders_of_serial_number` |  |
+| File folders of a subproject | `async_list_file_folders_of_subproject` | `async_iter_file_folders_of_subproject` |  |
+| File folders of a subrental | `async_list_file_folders_of_subrental` | `async_iter_file_folders_of_subrental` |  |
+| File folders of a supplier | `async_list_file_folders_of_supplier` | `async_iter_file_folders_of_supplier` |  |
+| File folders of a vehicle | `async_list_file_folders_of_vehicle` | `async_iter_file_folders_of_vehicle` |  |
+| Rates | `async_list_rates` | `async_iter_rates` | `async_get_rate` |
+| Rate factors | `async_list_rate_factors` | `async_iter_rate_factors` | `async_get_rate_factor` |
+| Rate factors of a rate | `async_list_rate_factors_of_rate` | `async_iter_rate_factors_of_rate` |  |
+| Factors | `async_list_factors` | `async_iter_factors` | `async_get_factor` |
+| Factors of a factor group | `async_list_factors_of_factor_group` | `async_iter_factors_of_factor_group` |  |
+| Factor groups | `async_list_factor_groups` | `async_iter_factor_groups` | `async_get_factor_group` |
+
+Writes cover every documented POST, PUT, and DELETE path:
+
+| Resource | Create | Update | Delete |
+| --- | --- | --- | --- |
+| Accessories of a material | `async_create_accessory_of_equipment` | `async_update_accessory` | `async_delete_accessory` |
+| Alternatives of a material | `async_create_alternative_of_equipment` | `async_update_alternative` | `async_delete_alternative` |
+| Appointments | `async_create_appointment` | `async_update_appointment` | `async_delete_appointment` |
+| Availability of a crew member | `async_create_crew_availability_of_crew` | `async_update_crew_availability` | `async_delete_crew_availability` |
+| Contact persons of a contact | `async_create_contact_person_of_contact` | `async_update_contact_person` | `async_delete_contact_person` |
+| Contacts | `async_create_contact` | `async_update_contact` | `async_delete_contact` |
+| Crew on an appointment | `async_create_appointment_crew_of_appointment` | `async_update_appointment_crew` | `async_delete_appointment_crew` |
+| Equipment (materials) | `async_create_equipment` | `async_update_equipment` |  |
+| Folders | `async_create_folder` | `async_update_folder` |  |
+| Function groups of a project | `async_create_project_function_group_of_project` |  |  |
+| Leave mutations | `async_create_leave_mutation` |  |  |
+| Leave requests | `async_create_leave_request` | `async_update_leave_request` |  |
+| Payments of an invoice | `async_create_payment_of_invoice` | `async_update_payment` |  |
+| Project costs of a project | `async_create_project_cost_of_project` | `async_update_project_cost` | `async_delete_project_cost` |
+| Project functions of a project | `async_create_project_function_of_project` |  |  |
+| Project requests | `async_create_project_request` | `async_update_project_request` | `async_delete_project_request` |
+| Projects | `async_create_project` |  |  |
+| Request equipment of a project request | `async_create_project_request_equipment_of_project_request` | `async_update_project_request_equipment` | `async_delete_project_request_equipment` |
+| Serial numbers of a material | `async_create_serial_number_of_equipment` | `async_update_serial_number` | `async_delete_serial_number` |
+| Set contents of a material | `async_create_equipment_set_content_of_equipment` | `async_update_equipment_set_content` | `async_delete_equipment_set_content` |
+| Stock movements of a material | `async_create_stock_movement_of_equipment` | `async_update_stock_movement` | `async_delete_stock_movement` |
+| Subprojects of a project | `async_create_subproject_of_project` |  |  |
+| Subtasks of a task | `async_create_subtask_of_task` | `async_update_subtask` | `async_delete_subtask` |
+| Suppliers of a material | `async_create_supplier_of_equipment` | `async_update_supplier` | `async_delete_supplier` |
+| Task assignments of a task | `async_create_task_assignment_of_task` | `async_update_task_assignment` | `async_delete_task_assignment` |
+| Task statuses | `async_create_task_status` | `async_update_task_status` | `async_delete_task_status` |
+| Tasks | `async_create_task`, `async_create_task_of_contact`, `async_create_task_of_contact_person`, `async_create_task_of_contract`, `async_create_task_of_crew`, `async_create_task_of_equipment`, `async_create_task_of_invoice`, `async_create_task_of_project`, `async_create_task_of_purchase_order`, `async_create_task_of_quote`, `async_create_task_of_repair`, `async_create_task_of_serial_number`, `async_create_task_of_subrental`, `async_create_task_of_supplier`, `async_create_task_of_vehicle` | `async_update_task` | `async_delete_task` |
+| Time registrations | `async_create_time_registration`, `async_create_time_registration_of_leave_request` | `async_update_time_registration` | `async_delete_time_registration` |
+| Vehicles | `async_create_vehicle`, `async_create_vehicle_of_stock_location` | `async_update_vehicle` | `async_delete_vehicle` |
+
+## Token
+
+Rentman issues one static token per user, generated in the application under Configuration, Integrations. Only the last generated token is valid. Pass it explicitly or set `RENTMAN_TOKEN`:
+
+```python
+import asyncio
+
+from aiorentman import RentmanClient
+
+
+async def main() -> None:
+    async with RentmanClient(token="your-api-token") as client:
+        page = await client.async_list_equipment()
+        print(page.item_count, "materials on this page")
+
+
+asyncio.run(main())
+```
+
+## Querying
+
+Every list method takes a `Query` with the field selection, sorting, filters, expansion, and paging that the API supports:
+
+```python
+from aiorentman import Query, Sort, eq, lt
+
+query = Query(
+    fields=("name", "code", "price"),
+    sort=(Sort("name"),),
+    expand=("folder",),
+    filters=(eq("code", "AUD-001"), lt("price", 200)),
+    limit=100,
+)
+page = await client.async_list_equipment(query)
+```
+
+Filters support the relational operators the API documents: `eq`, `neq`, `lt`, `lte`, `gt`, `gte`, and `is_null`. Field names come straight from the API schema, including `custom_<number>` custom fields.
+
+Linked fields such as `equipment.folder` hold a `RentmanLink` with the API path of the linked resource. Expand a field and the parser returns the full typed model instead.
+
+## RFID and materials
+
+Rentman links every RFID tag to exactly one serial number, and the tag identifier lands in the `qrcodes` field of that serial number. The library exposes `qrcodes` as a parsed tuple. That field is generated by the Rentman backend, and the API can neither filter nor sort on it, so an RFID scan resolves against a local index built from a serial number sync:
+
+```python
+index: dict[str, int] = {}
+query = Query(fields=("serial", "qrcodes", "equipment"), limit=1500)
+async for serial in client.async_iter_serial_numbers(query):
+    for tag in serial.qrcodes:
+        index[tag] = serial.id
+```
+
+The docs describe the full workflow, including expansion and availability checks: see `docs/serial-numbers.rst`.
+
+## Writing
+
+Create and update methods take one payload class per resource, named after the model plus `Payload`. Fields left unset are left out of the request body, so an update touches only what the caller set:
+
+```python
+from datetime import UTC, datetime
+
+from aiorentman import RentmanLink, TaskPayload
+
+task = await client.async_create_task(
+    TaskPayload(
+        color="#ff0000",
+        name="Patch the rig",
+        deadline=datetime(2026, 10, 6, 17, 0, tzinfo=UTC),
+        status=RentmanLink("/taskstatuses/2"),
+        custom={"custom_3": "truss"},
+    )
+)
+await client.async_update_task(task.id, TaskPayload(color="#ff0000", name="Patched"))
+await client.async_delete_task(task.id)
+```
+
+Datetime fields render as ISO 8601 and link fields take a `RentmanLink` holding the API path of the target. A create or update returns the parsed model of the saved object, or `None` when the response envelope degrades. A delete returns `None`. A 400 answer raises `RentmanValidationError` with the answer text in the message. Clearing a field to `null` is not supported, since fields left unset are not sent.
+
+## Rate limits
+
+Rentman allows 10 requests per second, at most 20 concurrent requests, and 50.000 requests per day. The client enforces the first two by default. Pass `requests_per_second=None` to disable pacing, or lower it when several consumers share one account. Exceeding the server-side limits raises `RentmanRateLimitError`.
+
+## Errors
+
+| Exception | Meaning |
+| --- | --- |
+| `RentmanAuthenticationError` | The token is missing or was rejected |
+| `RentmanAuthorizationError` | The token does not grant access to a resource |
+| `RentmanValidationError` | The API rejected a request body or query as invalid |
+| `RentmanRateLimitError` | The request exceeded the rate limits |
+| `RentmanCommunicationError` | The API is unreachable or answered with a failure |
+| `RentmanTimeoutError` | A request exceeded the configured timeout |
+| `RentmanInvalidResponseError` | A response payload was unusable |
+| `RentmanNotFoundError` | The requested object does not exist |
+| `RentmanClientClosedError` | The client was closed |
+
+## Development
+
+```bash
+uv sync
+uv run python -m scripts.check
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).