|
1 |
| -# integrations-api-sdk-php |
| 1 | +# SwaggerClient-php |
| 2 | +This API gives You the ability to build Your own application and integrate it with Docplanner services. |
| 3 | + |
| 4 | +This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: |
| 5 | + |
| 6 | +- API version: 0.0.1c |
| 7 | +- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen |
| 8 | + |
| 9 | +## Requirements |
| 10 | + |
| 11 | +PHP 5.5 and later |
| 12 | + |
| 13 | +## Installation & Usage |
| 14 | +### Composer |
| 15 | + |
| 16 | +To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: |
| 17 | + |
| 18 | +``` |
| 19 | +{ |
| 20 | + "repositories": [ |
| 21 | + { |
| 22 | + "type": "git", |
| 23 | + "url": "https://github.com/DocPlanner/integrations-api-sdk-php.git" |
| 24 | + } |
| 25 | + ], |
| 26 | + "require": { |
| 27 | + "DocPlanner/integrations-api-sdk-php": "*@dev" |
| 28 | + } |
| 29 | +} |
| 30 | +``` |
| 31 | + |
| 32 | +Then run `composer install` |
| 33 | + |
| 34 | +### Manual Installation |
| 35 | + |
| 36 | +Download the files and include `autoload.php`: |
| 37 | + |
| 38 | +```php |
| 39 | + require_once('/path/to/SwaggerClient-php/vendor/autoload.php'); |
| 40 | +``` |
| 41 | + |
| 42 | +## Tests |
| 43 | + |
| 44 | +To run the unit tests: |
| 45 | + |
| 46 | +``` |
| 47 | +composer install |
| 48 | +./vendor/bin/phpunit |
| 49 | +``` |
| 50 | + |
| 51 | +## Getting Started |
| 52 | + |
| 53 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 54 | + |
| 55 | +```php |
| 56 | +<?php |
| 57 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 58 | + |
| 59 | +// Configure OAuth2 access token for authorization: oauth2_client_credentials |
| 60 | +$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 61 | + |
| 62 | +$apiInstance = new DocPlanner\Client\Api\AddressesApi( |
| 63 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 64 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 65 | + new GuzzleHttp\Client(), |
| 66 | + $config |
| 67 | +); |
| 68 | +$facility_id = 56; // int | ID of the Facility |
| 69 | +$doctor_id = 56; // int | ID of a doctor in a facility |
| 70 | +$address_id = 56; // int | ID of a doctor`s address in a facility |
| 71 | +$with = array(new \DocPlanner\Client\Model\AddressesScopes()); // \DocPlanner\Client\Model\AddressesScopes[] | |
| 72 | + |
| 73 | +try { |
| 74 | + $result = $apiInstance->getAddress($facility_id, $doctor_id, $address_id, $with); |
| 75 | + print_r($result); |
| 76 | +} catch (Exception $e) { |
| 77 | + echo 'Exception when calling AddressesApi->getAddress: ', $e->getMessage(), PHP_EOL; |
| 78 | +} |
| 79 | + |
| 80 | +// Configure OAuth2 access token for authorization: oauth2_client_credentials |
| 81 | +$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 82 | + |
| 83 | +$apiInstance = new DocPlanner\Client\Api\AddressesApi( |
| 84 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 85 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 86 | + new GuzzleHttp\Client(), |
| 87 | + $config |
| 88 | +); |
| 89 | +$facility_id = 56; // int | ID of the Facility |
| 90 | +$doctor_id = 56; // int | ID of a doctor in a facility |
| 91 | +$with = array(new \DocPlanner\Client\Model\AddressesScopes()); // \DocPlanner\Client\Model\AddressesScopes[] | |
| 92 | + |
| 93 | +try { |
| 94 | + $result = $apiInstance->getAddresses($facility_id, $doctor_id, $with); |
| 95 | + print_r($result); |
| 96 | +} catch (Exception $e) { |
| 97 | + echo 'Exception when calling AddressesApi->getAddresses: ', $e->getMessage(), PHP_EOL; |
| 98 | +} |
| 99 | +?> |
| 100 | +``` |
| 101 | + |
| 102 | +## Documentation for API Endpoints |
| 103 | + |
| 104 | +All URIs are relative to *https://www.znanylekarz.pl/api/v3/integration* |
| 105 | + |
| 106 | +Class | Method | HTTP request | Description |
| 107 | +------------ | ------------- | ------------- | ------------- |
| 108 | +*AddressesApi* | [**getAddress**](docs/Api/AddressesApi.md#getaddress) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id} | |
| 109 | +*AddressesApi* | [**getAddresses**](docs/Api/AddressesApi.md#getaddresses) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses | |
| 110 | +*BookingsApi* | [**cancelBooking**](docs/Api/BookingsApi.md#cancelbooking) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id} | |
| 111 | +*BookingsApi* | [**getBooking**](docs/Api/BookingsApi.md#getbooking) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id} | |
| 112 | +*BookingsApi* | [**getBookings**](docs/Api/BookingsApi.md#getbookings) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings | |
| 113 | +*BookingsApi* | [**moveBooking**](docs/Api/BookingsApi.md#movebooking) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/move | |
| 114 | +*BookingsApi* | [**requestOpinion**](docs/Api/BookingsApi.md#requestopinion) | **PUT** /facilities/{facility_id}/doctors/{doctor_id}/opinion-request | |
| 115 | +*CalendarBreaksApi* | [**addCalendarBreak**](docs/Api/CalendarBreaksApi.md#addcalendarbreak) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks | |
| 116 | +*CalendarBreaksApi* | [**deleteCalendarBreak**](docs/Api/CalendarBreaksApi.md#deletecalendarbreak) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id} | |
| 117 | +*CalendarBreaksApi* | [**getCalendarBreak**](docs/Api/CalendarBreaksApi.md#getcalendarbreak) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks/{break_id} | |
| 118 | +*CalendarBreaksApi* | [**getCalendarBreaks**](docs/Api/CalendarBreaksApi.md#getcalendarbreaks) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/breaks | |
| 119 | +*DoctorsApi* | [**getDoctor**](docs/Api/DoctorsApi.md#getdoctor) | **GET** /facilities/{facility_id}/doctors/{doctor_id} | |
| 120 | +*DoctorsApi* | [**getDoctors**](docs/Api/DoctorsApi.md#getdoctors) | **GET** /facilities/{facility_id}/doctors | |
| 121 | +*FacilitiesApi* | [**getFacilities**](docs/Api/FacilitiesApi.md#getfacilities) | **GET** /facilities | |
| 122 | +*FacilitiesApi* | [**getFacility**](docs/Api/FacilitiesApi.md#getfacility) | **GET** /facilities/{facility_id} | |
| 123 | +*InsurancesApi* | [**addAddressInsuranceProvider**](docs/Api/InsurancesApi.md#addaddressinsuranceprovider) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers | |
| 124 | +*InsurancesApi* | [**deleteAddressInsuranceProvider**](docs/Api/InsurancesApi.md#deleteaddressinsuranceprovider) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers/{insurance_provider} | |
| 125 | +*InsurancesApi* | [**getAddressInsuranceProviders**](docs/Api/InsurancesApi.md#getaddressinsuranceproviders) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/insurance-providers | |
| 126 | +*InsurancesApi* | [**getInsuranceProviders**](docs/Api/InsurancesApi.md#getinsuranceproviders) | **GET** /insurance-providers | |
| 127 | +*PatientPresenceApi* | [**markPatientAbsence**](docs/Api/PatientPresenceApi.md#markpatientabsence) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient | |
| 128 | +*PatientPresenceApi* | [**markPatientPresence**](docs/Api/PatientPresenceApi.md#markpatientpresence) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient | |
| 129 | +*ServicesApi* | [**addAddressService**](docs/Api/ServicesApi.md#addaddressservice) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services | |
| 130 | +*ServicesApi* | [**deleteAddressService**](docs/Api/ServicesApi.md#deleteaddressservice) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} | |
| 131 | +*ServicesApi* | [**getAddressService**](docs/Api/ServicesApi.md#getaddressservice) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} | |
| 132 | +*ServicesApi* | [**getAddressServices**](docs/Api/ServicesApi.md#getaddressservices) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services | |
| 133 | +*ServicesApi* | [**getServices**](docs/Api/ServicesApi.md#getservices) | **GET** /services | |
| 134 | +*ServicesApi* | [**updateAddressService**](docs/Api/ServicesApi.md#updateaddressservice) | **PATCH** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} | |
| 135 | +*SlotsApi* | [**bookSlot**](docs/Api/SlotsApi.md#bookslot) | **POST** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots/{start}/book | |
| 136 | +*SlotsApi* | [**deleteSlots**](docs/Api/SlotsApi.md#deleteslots) | **DELETE** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots/{date} | |
| 137 | +*SlotsApi* | [**getSlots**](docs/Api/SlotsApi.md#getslots) | **GET** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots | |
| 138 | +*SlotsApi* | [**replaceSlots**](docs/Api/SlotsApi.md#replaceslots) | **PUT** /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots | |
| 139 | + |
| 140 | +## Documentation For Models |
| 141 | + |
| 142 | + - [AddAddressInsuranceProviderRequest](docs/Model/AddAddressInsuranceProviderRequest.md) |
| 143 | + - [AddAddressServiceRequest](docs/Model/AddAddressServiceRequest.md) |
| 144 | + - [AddCalendarBreakRequest](docs/Model/AddCalendarBreakRequest.md) |
| 145 | + - [Address](docs/Model/Address.md) |
| 146 | + - [AddressBookingExtraFields](docs/Model/AddressBookingExtraFields.md) |
| 147 | + - [AddressScopes](docs/Model/AddressScopes.md) |
| 148 | + - [AddressService](docs/Model/AddressService.md) |
| 149 | + - [AddressServices](docs/Model/AddressServices.md) |
| 150 | + - [Addresses](docs/Model/Addresses.md) |
| 151 | + - [AddressesScopes](docs/Model/AddressesScopes.md) |
| 152 | + - [BookSlotRequest](docs/Model/BookSlotRequest.md) |
| 153 | + - [Booking](docs/Model/Booking.md) |
| 154 | + - [BookingScopes](docs/Model/BookingScopes.md) |
| 155 | + - [Bookings](docs/Model/Bookings.md) |
| 156 | + - [BookingsScopes](docs/Model/BookingsScopes.md) |
| 157 | + - [CalendarBreak](docs/Model/CalendarBreak.md) |
| 158 | + - [CalendarBreaks](docs/Model/CalendarBreaks.md) |
| 159 | + - [Doctor](docs/Model/Doctor.md) |
| 160 | + - [DoctorScopes](docs/Model/DoctorScopes.md) |
| 161 | + - [Doctors](docs/Model/Doctors.md) |
| 162 | + - [DoctorsScopes](docs/Model/DoctorsScopes.md) |
| 163 | + - [Error](docs/Model/Error.md) |
| 164 | + - [Facilities](docs/Model/Facilities.md) |
| 165 | + - [Facility](docs/Model/Facility.md) |
| 166 | + - [FacilityScopes](docs/Model/FacilityScopes.md) |
| 167 | + - [InsuranceProvider](docs/Model/InsuranceProvider.md) |
| 168 | + - [InsuranceProviders](docs/Model/InsuranceProviders.md) |
| 169 | + - [MoveBookingRequest](docs/Model/MoveBookingRequest.md) |
| 170 | + - [OpinionRequest](docs/Model/OpinionRequest.md) |
| 171 | + - [Patient](docs/Model/Patient.md) |
| 172 | + - [ReplaceSlotsRequest](docs/Model/ReplaceSlotsRequest.md) |
| 173 | + - [ReplaceSlotsRequestAddressServices](docs/Model/ReplaceSlotsRequestAddressServices.md) |
| 174 | + - [ReplaceSlotsRequestSlots](docs/Model/ReplaceSlotsRequestSlots.md) |
| 175 | + - [Service](docs/Model/Service.md) |
| 176 | + - [Services](docs/Model/Services.md) |
| 177 | + - [ServicesScopes](docs/Model/ServicesScopes.md) |
| 178 | + - [Slot](docs/Model/Slot.md) |
| 179 | + - [Slots](docs/Model/Slots.md) |
| 180 | + - [SlotsScopes](docs/Model/SlotsScopes.md) |
| 181 | + - [Specialization](docs/Model/Specialization.md) |
| 182 | + - [Specializations](docs/Model/Specializations.md) |
| 183 | + - [UpdateAddressServiceRequest](docs/Model/UpdateAddressServiceRequest.md) |
| 184 | + |
| 185 | +## Documentation For Authorization |
| 186 | + |
| 187 | + |
| 188 | +## oauth2_client_credentials |
| 189 | + |
| 190 | +- **Type**: OAuth |
| 191 | +- **Flow**: application |
| 192 | +- **Authorization URL**: |
| 193 | +- **Scopes**: |
| 194 | + - ****: |
| 195 | + |
| 196 | + |
| 197 | +## Author |
| 198 | + |
| 199 | + |
| 200 | + |
0 commit comments