Skip to content

Commit 822ce3d

Browse files
committed
readme
1 parent 6ed032c commit 822ce3d

File tree

2 files changed

+15
-61
lines changed

2 files changed

+15
-61
lines changed

README.md

Lines changed: 14 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,34 @@
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-
91
## Requirements
102

11-
PHP 5.5 and later
3+
PHP >= 5.5
4+
5+
Guzzle/guzzle >= 6.2
126

137
## Installation & Usage
148
### Composer
159

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`
10+
To install the bindings via [Composer](http://getcomposer.org/), run `composer require docplanner/integrations-api-sdk-php`.
3311

3412
### Manual Installation
3513

3614
Download the files and include `autoload.php`:
3715

3816
```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
17+
require_once('/path/to/DocPlanner/Client/vendor/autoload.php');
4918
```
50-
5119
## Getting Started
5220

5321
Please follow the [installation procedure](#installation--usage) and then run the following:
5422

5523
```php
5624
<?php
5725
require_once(__DIR__ . '/vendor/autoload.php');
26+
//Get OAuth2 access token
27+
$authorization = new DocPlanner\Client\Authorization('AUTHORIZATION_URL');
28+
$accessToken = $authorization->getAccessToken('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET');
5829

59-
// Configure OAuth2 access token for authorization: oauth2_client_credentials
60-
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
30+
// Configure access token for authorization
31+
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken($accessToken);
6132

6233
$apiInstance = new DocPlanner\Client\Api\AddressesApi(
6334
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -68,7 +39,7 @@ $apiInstance = new DocPlanner\Client\Api\AddressesApi(
6839
$facility_id = 56; // int | ID of the Facility
6940
$doctor_id = 56; // int | ID of a doctor in a facility
7041
$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[] |
42+
$with = array(\DocPlanner\Client\Model\AddressScopes::VISIT_PAYMENT); // string[] |
7243

7344
try {
7445
$result = $apiInstance->getAddress($facility_id, $doctor_id, $address_id, $with);
@@ -77,8 +48,8 @@ try {
7748
echo 'Exception when calling AddressesApi->getAddress: ', $e->getMessage(), PHP_EOL;
7849
}
7950

80-
// Configure OAuth2 access token for authorization: oauth2_client_credentials
81-
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
51+
// Configure access token for authorization
52+
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken($accessToken);
8253

8354
$apiInstance = new DocPlanner\Client\Api\AddressesApi(
8455
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -88,7 +59,7 @@ $apiInstance = new DocPlanner\Client\Api\AddressesApi(
8859
);
8960
$facility_id = 56; // int | ID of the Facility
9061
$doctor_id = 56; // int | ID of a doctor in a facility
91-
$with = array(new \DocPlanner\Client\Model\AddressesScopes()); // \DocPlanner\Client\Model\AddressesScopes[] |
62+
$with = DocPlanner\Client\Model\AddressesScopes::getAllowableEnumValues(); // string[] |
9263

9364
try {
9465
$result = $apiInstance->getAddresses($facility_id, $doctor_id, $with);
@@ -181,20 +152,3 @@ Class | Method | HTTP request | Description
181152
- [Specialization](docs/Model/Specialization.md)
182153
- [Specializations](docs/Model/Specializations.md)
183154
- [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-

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "DocPlanner/integrations-api-sdk-php",
2+
"name": "docplanner/integrations-api-sdk-php",
33
"description": "DocPlanner integration API SDK",
44
"keywords": [
55
"php",

0 commit comments

Comments
 (0)