admin/omsorg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e9e96a57dce183fec8d1ee2d4595b5deb0c7c9f1
omsorg/omsorgWeb/mitarbeiter-app/api-client-php/README.md
T
Felix KemmlerandClaude Sonnet 5 e9e96a57dc Add facilities, contracts, orders, value lists, audit log, and desktop app modules 
Extends omsorgCore with full CRUD for Facility/Contract/Order plus
configurable value lists and an audit trail, and wires the omsorgapp
frontend up to the new facilities, settings, and audit-log modules;
includes a sidebar active-nav-item highlight.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-08 23:29:16 +02:00

216 lines
12 KiB
Markdown
Raw Blame History

# omsorgcore-client-php
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
## Installation & Usage
### Requirements
PHP 8.1 and later.
### Composer
To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
<?php
require_once('/path/to/omsorgcore-client-php/vendor/autoload.php');
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OmsorgCoreClient\Api\AdminEmailApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->apiAdminEmailPasswordResetTemplateGet();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AdminEmailApi->apiAdminEmailPasswordResetTemplateGet: ', $e->getMessage(), PHP_EOL;
}
```
## API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminEmailApi* | [**apiAdminEmailPasswordResetTemplateGet**](docs/Api/AdminEmailApi.md#apiadminemailpasswordresettemplateget) | **GET** /api/admin/email/password-reset-template |
*AdminEmailApi* | [**apiAdminEmailTestSendPost**](docs/Api/AdminEmailApi.md#apiadminemailtestsendpost) | **POST** /api/admin/email/test-send |
*AdminSessionsApi* | [**apiAdminSessionsGet**](docs/Api/AdminSessionsApi.md#apiadminsessionsget) | **GET** /api/admin/sessions |
*AdminSessionsApi* | [**apiAdminSessionsIdRevokePost**](docs/Api/AdminSessionsApi.md#apiadminsessionsidrevokepost) | **POST** /api/admin/sessions/{id}/revoke |
*AdminSessionsApi* | [**apiAdminSessionsRevokeAllPost**](docs/Api/AdminSessionsApi.md#apiadminsessionsrevokeallpost) | **POST** /api/admin/sessions/revoke-all |
*AuditLogApi* | [**apiAuditLogGet**](docs/Api/AuditLogApi.md#apiauditlogget) | **GET** /api/audit-log |
*AuthApi* | [**apiAuthChangePasswordPost**](docs/Api/AuthApi.md#apiauthchangepasswordpost) | **POST** /api/auth/change-password |
*AuthApi* | [**apiAuthForgotPasswordRequestPost**](docs/Api/AuthApi.md#apiauthforgotpasswordrequestpost) | **POST** /api/auth/forgot-password/request |
*AuthApi* | [**apiAuthForgotPasswordResetPost**](docs/Api/AuthApi.md#apiauthforgotpasswordresetpost) | **POST** /api/auth/forgot-password/reset |
*AuthApi* | [**apiAuthForgotPasswordVerifyPost**](docs/Api/AuthApi.md#apiauthforgotpasswordverifypost) | **POST** /api/auth/forgot-password/verify |
*AuthApi* | [**apiAuthLoginPost**](docs/Api/AuthApi.md#apiauthloginpost) | **POST** /api/auth/login |
*AuthApi* | [**apiAuthLogoutPost**](docs/Api/AuthApi.md#apiauthlogoutpost) | **POST** /api/auth/logout |
*AuthApi* | [**apiAuthMeGet**](docs/Api/AuthApi.md#apiauthmeget) | **GET** /api/auth/me |
*AuthApi* | [**apiAuthPasswordPolicyGet**](docs/Api/AuthApi.md#apiauthpasswordpolicyget) | **GET** /api/auth/password-policy |
*AuthApi* | [**apiAuthRefreshPost**](docs/Api/AuthApi.md#apiauthrefreshpost) | **POST** /api/auth/refresh |
*ContractsApi* | [**apiContractsGet**](docs/Api/ContractsApi.md#apicontractsget) | **GET** /api/contracts |
*ContractsApi* | [**apiContractsIdGet**](docs/Api/ContractsApi.md#apicontractsidget) | **GET** /api/contracts/{id} |
*ContractsApi* | [**apiContractsIdPut**](docs/Api/ContractsApi.md#apicontractsidput) | **PUT** /api/contracts/{id} |
*ContractsApi* | [**apiContractsPost**](docs/Api/ContractsApi.md#apicontractspost) | **POST** /api/contracts |
*EmployeesApi* | [**apiEmployeesGet**](docs/Api/EmployeesApi.md#apiemployeesget) | **GET** /api/employees |
*EmployeesApi* | [**apiEmployeesIdGet**](docs/Api/EmployeesApi.md#apiemployeesidget) | **GET** /api/employees/{id} |
*EmployeesApi* | [**apiEmployeesIdPut**](docs/Api/EmployeesApi.md#apiemployeesidput) | **PUT** /api/employees/{id} |
*EmployeesApi* | [**apiEmployeesPost**](docs/Api/EmployeesApi.md#apiemployeespost) | **POST** /api/employees |
*FacilitiesApi* | [**apiFacilitiesGet**](docs/Api/FacilitiesApi.md#apifacilitiesget) | **GET** /api/facilities |
*FacilitiesApi* | [**apiFacilitiesIdGet**](docs/Api/FacilitiesApi.md#apifacilitiesidget) | **GET** /api/facilities/{id} |
*FacilitiesApi* | [**apiFacilitiesIdPut**](docs/Api/FacilitiesApi.md#apifacilitiesidput) | **PUT** /api/facilities/{id} |
*FacilitiesApi* | [**apiFacilitiesPost**](docs/Api/FacilitiesApi.md#apifacilitiespost) | **POST** /api/facilities |
*FacilityContactsApi* | [**apiFacilitiesFacilityIdContactsGet**](docs/Api/FacilityContactsApi.md#apifacilitiesfacilityidcontactsget) | **GET** /api/facilities/{facilityId}/contacts |
*FacilityContactsApi* | [**apiFacilitiesFacilityIdContactsIdPut**](docs/Api/FacilityContactsApi.md#apifacilitiesfacilityidcontactsidput) | **PUT** /api/facilities/{facilityId}/contacts/{id} |
*FacilityContactsApi* | [**apiFacilitiesFacilityIdContactsPost**](docs/Api/FacilityContactsApi.md#apifacilitiesfacilityidcontactspost) | **POST** /api/facilities/{facilityId}/contacts |
*HealthApi* | [**apiHealthGet**](docs/Api/HealthApi.md#apihealthget) | **GET** /api/health |
*OrdersApi* | [**apiOrdersGet**](docs/Api/OrdersApi.md#apiordersget) | **GET** /api/orders |
*OrdersApi* | [**apiOrdersIdGet**](docs/Api/OrdersApi.md#apiordersidget) | **GET** /api/orders/{id} |
*OrdersApi* | [**apiOrdersIdPut**](docs/Api/OrdersApi.md#apiordersidput) | **PUT** /api/orders/{id} |
*OrdersApi* | [**apiOrdersPost**](docs/Api/OrdersApi.md#apiorderspost) | **POST** /api/orders |
*RolesApi* | [**apiRolesGet**](docs/Api/RolesApi.md#apirolesget) | **GET** /api/roles |
*RolesApi* | [**apiRolesIdGet**](docs/Api/RolesApi.md#apirolesidget) | **GET** /api/roles/{id} |
*RolesApi* | [**apiRolesIdPermissionsPut**](docs/Api/RolesApi.md#apirolesidpermissionsput) | **PUT** /api/roles/{id}/permissions |
*RolesApi* | [**apiRolesPost**](docs/Api/RolesApi.md#apirolespost) | **POST** /api/roles |
*UsersApi* | [**apiUsersGet**](docs/Api/UsersApi.md#apiusersget) | **GET** /api/users |
*UsersApi* | [**apiUsersIdPermissionOverridesGet**](docs/Api/UsersApi.md#apiusersidpermissionoverridesget) | **GET** /api/users/{id}/permission-overrides |
*UsersApi* | [**apiUsersIdPermissionOverridesOverrideIdDelete**](docs/Api/UsersApi.md#apiusersidpermissionoverridesoverrideiddelete) | **DELETE** /api/users/{id}/permission-overrides/{overrideId} |
*UsersApi* | [**apiUsersIdPermissionOverridesPost**](docs/Api/UsersApi.md#apiusersidpermissionoverridespost) | **POST** /api/users/{id}/permission-overrides |
*UsersApi* | [**apiUsersIdPut**](docs/Api/UsersApi.md#apiusersidput) | **PUT** /api/users/{id} |
*UsersApi* | [**apiUsersIdResetPasswordPost**](docs/Api/UsersApi.md#apiusersidresetpasswordpost) | **POST** /api/users/{id}/reset-password |
*UsersApi* | [**apiUsersPost**](docs/Api/UsersApi.md#apiuserspost) | **POST** /api/users |
*ValueListsApi* | [**apiValueListsGet**](docs/Api/ValueListsApi.md#apivaluelistsget) | **GET** /api/value-lists |
*ValueListsApi* | [**apiValueListsKeyItemsGet**](docs/Api/ValueListsApi.md#apivaluelistskeyitemsget) | **GET** /api/value-lists/{key}/items |
*ValueListsApi* | [**apiValueListsKeyItemsIdDelete**](docs/Api/ValueListsApi.md#apivaluelistskeyitemsiddelete) | **DELETE** /api/value-lists/{key}/items/{id} |
*ValueListsApi* | [**apiValueListsKeyItemsIdPut**](docs/Api/ValueListsApi.md#apivaluelistskeyitemsidput) | **PUT** /api/value-lists/{key}/items/{id} |
*ValueListsApi* | [**apiValueListsKeyItemsIdUsagesGet**](docs/Api/ValueListsApi.md#apivaluelistskeyitemsidusagesget) | **GET** /api/value-lists/{key}/items/{id}/usages |
*ValueListsApi* | [**apiValueListsKeyItemsPost**](docs/Api/ValueListsApi.md#apivaluelistskeyitemspost) | **POST** /api/value-lists/{key}/items |
*ValueListsApi* | [**apiValueListsKeyTransitionsGet**](docs/Api/ValueListsApi.md#apivaluelistskeytransitionsget) | **GET** /api/value-lists/{key}/transitions |
*ValueListsApi* | [**apiValueListsKeyTransitionsPut**](docs/Api/ValueListsApi.md#apivaluelistskeytransitionsput) | **PUT** /api/value-lists/{key}/transitions |
## Models
- [AddUserPermissionOverrideRequest](docs/Model/AddUserPermissionOverrideRequest.md)
- [AuditLogEntryResponse](docs/Model/AuditLogEntryResponse.md)
- [AuditLogEntryResponsePagedResponse](docs/Model/AuditLogEntryResponsePagedResponse.md)
- [ChangePasswordRequest](docs/Model/ChangePasswordRequest.md)
- [ContractResponse](docs/Model/ContractResponse.md)
- [ContractResponsePagedResponse](docs/Model/ContractResponsePagedResponse.md)
- [CreateContractRequest](docs/Model/CreateContractRequest.md)
- [CreateEmployeeRequest](docs/Model/CreateEmployeeRequest.md)
- [CreateFacilityContactRequest](docs/Model/CreateFacilityContactRequest.md)
- [CreateFacilityRequest](docs/Model/CreateFacilityRequest.md)
- [CreateOrderRequest](docs/Model/CreateOrderRequest.md)
- [CreateRoleRequest](docs/Model/CreateRoleRequest.md)
- [CreateUserRequest](docs/Model/CreateUserRequest.md)
- [CreateValueListItemRequest](docs/Model/CreateValueListItemRequest.md)
- [EmployeeResponse](docs/Model/EmployeeResponse.md)
- [EmployeeResponsePagedResponse](docs/Model/EmployeeResponsePagedResponse.md)
- [FacilityContactResponse](docs/Model/FacilityContactResponse.md)
- [FacilityResponse](docs/Model/FacilityResponse.md)
- [FacilityResponsePagedResponse](docs/Model/FacilityResponsePagedResponse.md)
- [ForgotPasswordRequestRequest](docs/Model/ForgotPasswordRequestRequest.md)
- [ForgotPasswordRequestResponse](docs/Model/ForgotPasswordRequestResponse.md)
- [ForgotPasswordResetRequest](docs/Model/ForgotPasswordResetRequest.md)
- [ForgotPasswordVerifyRequest](docs/Model/ForgotPasswordVerifyRequest.md)
- [ForgotPasswordVerifyResponse](docs/Model/ForgotPasswordVerifyResponse.md)
- [LoginRequest](docs/Model/LoginRequest.md)
- [LoginResponse](docs/Model/LoginResponse.md)
- [LogoutRequest](docs/Model/LogoutRequest.md)
- [MeResponse](docs/Model/MeResponse.md)
- [OrderResponse](docs/Model/OrderResponse.md)
- [OrderResponsePagedResponse](docs/Model/OrderResponsePagedResponse.md)
- [PasswordPolicyResponse](docs/Model/PasswordPolicyResponse.md)
- [PasswordResetTemplateResponse](docs/Model/PasswordResetTemplateResponse.md)
- [PermissionDto](docs/Model/PermissionDto.md)
- [RefreshRequest](docs/Model/RefreshRequest.md)
- [ResetUserPasswordRequest](docs/Model/ResetUserPasswordRequest.md)
- [RolePermissionsResponse](docs/Model/RolePermissionsResponse.md)
- [RoleResponse](docs/Model/RoleResponse.md)
- [SendTestEmailRequest](docs/Model/SendTestEmailRequest.md)
- [SessionResponse](docs/Model/SessionResponse.md)
- [UpdateContractRequest](docs/Model/UpdateContractRequest.md)
- [UpdateEmployeeRequest](docs/Model/UpdateEmployeeRequest.md)
- [UpdateFacilityContactRequest](docs/Model/UpdateFacilityContactRequest.md)
- [UpdateFacilityRequest](docs/Model/UpdateFacilityRequest.md)
- [UpdateOrderRequest](docs/Model/UpdateOrderRequest.md)
- [UpdateRolePermissionsRequest](docs/Model/UpdateRolePermissionsRequest.md)
- [UpdateUserRequest](docs/Model/UpdateUserRequest.md)
- [UpdateValueListItemRequest](docs/Model/UpdateValueListItemRequest.md)
- [UserPermissionOverrideResponse](docs/Model/UserPermissionOverrideResponse.md)
- [UserResponse](docs/Model/UserResponse.md)
- [ValueListItemResponse](docs/Model/ValueListItemResponse.md)
- [ValueListResponse](docs/Model/ValueListResponse.md)
- [ValueListTransitionRequest](docs/Model/ValueListTransitionRequest.md)
- [ValueListTransitionResponse](docs/Model/ValueListTransitionResponse.md)
- [ValueListUsageResponse](docs/Model/ValueListUsageResponse.md)
## Authorization
Authentication schemes defined for the API:
### Bearer
- **Type**: Bearer authentication (JWT)
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```
## Author
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `1.0`
- Generator version: `7.14.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
Reference in New Issue View Git Blame Copy Permalink