euromedica-client/docs/Api/WelcomeApi.md

169 lines
3.6 KiB
Markdown

# Europharmacy\EuromedicaClient\WelcomeApi
All URIs are relative to http://localhost, except if the operation defines another base path.
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**apiWelcomeGet()**](WelcomeApi.md#apiWelcomeGet) | **GET** /api/Welcome | |
| [**apiWelcomeHead()**](WelcomeApi.md#apiWelcomeHead) | **HEAD** /api/Welcome | |
| [**apiWelcomeSecureGet()**](WelcomeApi.md#apiWelcomeSecureGet) | **GET** /api/Welcome/Secure | |
## `apiWelcomeGet()`
```php
apiWelcomeGet(): string
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Europharmacy\EuromedicaClient\Api\WelcomeApi(
// 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()
);
try {
$result = $apiInstance->apiWelcomeGet();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WelcomeApi->apiWelcomeGet: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
**string**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `apiWelcomeHead()`
```php
apiWelcomeHead()
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Europharmacy\EuromedicaClient\Api\WelcomeApi(
// 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()
);
try {
$apiInstance->apiWelcomeHead();
} catch (Exception $e) {
echo 'Exception when calling WelcomeApi->apiWelcomeHead: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
## `apiWelcomeSecureGet()`
```php
apiWelcomeSecureGet(): string
```
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basic
$config = Europharmacy\EuromedicaClient\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Europharmacy\EuromedicaClient\Api\WelcomeApi(
// 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->apiWelcomeSecureGet();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WelcomeApi->apiWelcomeSecureGet: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
**string**
### Authorization
[basic](../../README.md#basic)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)