Skip to content

Commit 83cbc4b

Browse files
actions-useractions-user
committed
Release v1.0.8
 * New (optional) property **send_notifications** for **CancelBookingRequest** (it is now possible to set if the patient should get notifications on canceling the visit)
1 parent 584e337 commit 83cbc4b

File tree

2 files changed

+794
-0
lines changed

2 files changed

+794
-0
lines changed

‎docs/Api/CalendarsApi.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# DocPlanner\Client\CalendarsApi
2+
3+
All URIs are relative to *https://www.{domain}/api/v3/integration*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**disableCalendar**](CalendarsApi.md#disablecalendar) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/disable |
8+
[**enableCalendar**](CalendarsApi.md#enablecalendar) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/enable |
9+
10+
# **disableCalendar**
11+
> disableCalendar($facility_id, $doctor_id, $address_id)
12+
13+
14+
15+
Disable calendar on the address
16+
17+
### Example
18+
```php
19+
<?php
20+
require_once(__DIR__ . '/vendor/autoload.php');
21+
22+
// Configure OAuth2 access token for authorization: OAuth 2.0
23+
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
24+
25+
$apiInstance = new DocPlanner\Client\Api\CalendarsApi(
26+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
27+
// This is optional, `GuzzleHttp\Client` will be used as default.
28+
new GuzzleHttp\Client(),
29+
$config
30+
);
31+
$facility_id = "facility_id_example"; // string | ID of the Facility
32+
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
33+
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
34+
35+
try {
36+
$apiInstance->disableCalendar($facility_id, $doctor_id, $address_id);
37+
} catch (Exception $e) {
38+
echo 'Exception when calling CalendarsApi->disableCalendar: ', $e->getMessage(), PHP_EOL;
39+
}
40+
?>
41+
```
42+
43+
### Parameters
44+
45+
Name | Type | Description | Notes
46+
------------- | ------------- | ------------- | -------------
47+
**facility_id** | **string**| ID of the Facility |
48+
**doctor_id** | **string**| ID of a doctor in a facility |
49+
**address_id** | **string**| ID of a doctor&#x60;s address in a facility |
50+
51+
### Return type
52+
53+
void (empty response body)
54+
55+
### Authorization
56+
57+
[OAuth 2.0](../../README.md#OAuth 2.0)
58+
59+
### HTTP request headers
60+
61+
- **Content-Type**: Not defined
62+
- **Accept**: application/vnd.error+docplanner+json
63+
64+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
65+
66+
# **enableCalendar**
67+
> enableCalendar($facility_id, $doctor_id, $address_id)
68+
69+
70+
71+
Enable calendar on the address
72+
73+
### Example
74+
```php
75+
<?php
76+
require_once(__DIR__ . '/vendor/autoload.php');
77+
78+
// Configure OAuth2 access token for authorization: OAuth 2.0
79+
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
80+
81+
$apiInstance = new DocPlanner\Client\Api\CalendarsApi(
82+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
83+
// This is optional, `GuzzleHttp\Client` will be used as default.
84+
new GuzzleHttp\Client(),
85+
$config
86+
);
87+
$facility_id = "facility_id_example"; // string | ID of the Facility
88+
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
89+
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
90+
91+
try {
92+
$apiInstance->enableCalendar($facility_id, $doctor_id, $address_id);
93+
} catch (Exception $e) {
94+
echo 'Exception when calling CalendarsApi->enableCalendar: ', $e->getMessage(), PHP_EOL;
95+
}
96+
?>
97+
```
98+
99+
### Parameters
100+
101+
Name | Type | Description | Notes
102+
------------- | ------------- | ------------- | -------------
103+
**facility_id** | **string**| ID of the Facility |
104+
**doctor_id** | **string**| ID of a doctor in a facility |
105+
**address_id** | **string**| ID of a doctor&#x60;s address in a facility |
106+
107+
### Return type
108+
109+
void (empty response body)
110+
111+
### Authorization
112+
113+
[OAuth 2.0](../../README.md#OAuth 2.0)
114+
115+
### HTTP request headers
116+
117+
- **Content-Type**: Not defined
118+
- **Accept**: application/vnd.error+docplanner+json
119+
120+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
121+

0 commit comments

Comments
 (0)