Skip to content

Commit 7708f58

Browse files
GuidoOffermansGuidoOffermans
committed
generate a new client with swagger-codegen 3.0.29
1 parent 71bd2c4 commit 7708f58

File tree

422 files changed

+32459
-9293
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

422 files changed

+32459
-9293
lines changed

‎.php_cs

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
<?php
22

3-
return PhpCsFixer\Config::create()
3+
return Symfony\CS\Config::create()
4+
->level(Symfony\CS\FixerInterface::PSR2_LEVEL)
45
->setUsingCache(true)
5-
->setRules([
6-
'@PSR2' => true,
7-
'ordered_imports' => true,
8-
'phpdoc_order' => true,
9-
'array_syntax' => [ 'syntax' => 'short' ],
10-
'strict_comparison' => true,
11-
'strict_param' => true,
12-
'no_trailing_whitespace' => false,
13-
'no_trailing_whitespace_in_comment' => false,
14-
'braces' => false,
15-
'single_blank_line_at_eof' => false,
16-
'blank_line_after_namespace' => false,
17-
])
18-
->setFinder(
19-
PhpCsFixer\Finder::create()
20-
->exclude('test')
21-
->exclude('tests')
22-
->in(__DIR__)
6+
->fixers(
7+
[
8+
'ordered_use',
9+
'phpdoc_order',
10+
'short_array_syntax',
11+
'strict',
12+
'strict_param'
13+
]
14+
)
15+
->finder(
16+
Symfony\CS\Finder\DefaultFinder::create()
17+
->in(__DIR__)
2318
);

‎README.md

Lines changed: 191 additions & 25 deletions
Large diffs are not rendered by default.

‎composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"require-dev": {
2626
"phpunit/phpunit": "^4.8",
2727
"squizlabs/php_codesniffer": "~2.6",
28-
"friendsofphp/php-cs-fixer": "~2.12"
28+
"friendsofphp/php-cs-fixer": "~1.12"
2929
},
3030
"autoload": {
3131
"psr-4": { "Yoast\\MyYoastApiClient\\" : "src/" }

‎docs/Api/AdmissionApi.md

Lines changed: 338 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,338 @@
1+
# Yoast\MyYoastApiClient\AdmissionApi
2+
3+
All URIs are relative to *http://my.yoast.test:3000/*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**apiAdmissionsGet**](AdmissionApi.md#apiadmissionsget) | **GET** /api/Admissions | Get admissions
8+
[**apiAdmissionsIdGet**](AdmissionApi.md#apiadmissionsidget) | **GET** /api/Admissions/{id} | Get an admission
9+
[**apiAdmissionsIdPut**](AdmissionApi.md#apiadmissionsidput) | **PUT** /api/Admissions/{id} | Update an admission
10+
[**apiAdmissionsPagedGet**](AdmissionApi.md#apiadmissionspagedget) | **GET** /api/Admissions/paged | Get admissions
11+
[**apiAdmissionsPost**](AdmissionApi.md#apiadmissionspost) | **POST** /api/Admissions | Invite a customer
12+
[**apiAdmissionsTransferPost**](AdmissionApi.md#apiadmissionstransferpost) | **POST** /api/Admissions/transfer | Transfer admissions between customers
13+
14+
# **apiAdmissionsGet**
15+
> \Yoast\MyYoastApiClient\Model\Admission[] apiAdmissionsGet($filter)
16+
17+
Get admissions
18+
19+
Get and filter admissions
20+
21+
### Example
22+
```php
23+
<?php
24+
require_once(__DIR__ . '/vendor/autoload.php');
25+
// Configure API key authorization: bearer
26+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
27+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
28+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
29+
30+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
31+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
32+
// This is optional, `GuzzleHttp\Client` will be used as default.
33+
new GuzzleHttp\Client(),
34+
$config
35+
);
36+
$filter = new \stdClass; // object | Used for filtering/joining the results.
37+
38+
try {
39+
$result = $apiInstance->apiAdmissionsGet($filter);
40+
print_r($result);
41+
} catch (Exception $e) {
42+
echo 'Exception when calling AdmissionApi->apiAdmissionsGet: ', $e->getMessage(), PHP_EOL;
43+
}
44+
?>
45+
```
46+
47+
### Parameters
48+
49+
Name | Type | Description | Notes
50+
------------- | ------------- | ------------- | -------------
51+
**filter** | [**object**](../Model/.md)| Used for filtering/joining the results. | [optional]
52+
53+
### Return type
54+
55+
[**\Yoast\MyYoastApiClient\Model\Admission[]**](../Model/Admission.md)
56+
57+
### Authorization
58+
59+
[bearer](../../README.md#bearer)
60+
61+
### HTTP request headers
62+
63+
- **Content-Type**: Not defined
64+
- **Accept**: application/json
65+
66+
[[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)
67+
68+
# **apiAdmissionsIdGet**
69+
> \Yoast\MyYoastApiClient\Model\Admission apiAdmissionsIdGet($id)
70+
71+
Get an admission
72+
73+
Get a single admission
74+
75+
### Example
76+
```php
77+
<?php
78+
require_once(__DIR__ . '/vendor/autoload.php');
79+
// Configure API key authorization: bearer
80+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
81+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
82+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
83+
84+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
85+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
86+
// This is optional, `GuzzleHttp\Client` will be used as default.
87+
new GuzzleHttp\Client(),
88+
$config
89+
);
90+
$id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
91+
92+
try {
93+
$result = $apiInstance->apiAdmissionsIdGet($id);
94+
print_r($result);
95+
} catch (Exception $e) {
96+
echo 'Exception when calling AdmissionApi->apiAdmissionsIdGet: ', $e->getMessage(), PHP_EOL;
97+
}
98+
?>
99+
```
100+
101+
### Parameters
102+
103+
Name | Type | Description | Notes
104+
------------- | ------------- | ------------- | -------------
105+
**id** | [**string**](../Model/.md)| |
106+
107+
### Return type
108+
109+
[**\Yoast\MyYoastApiClient\Model\Admission**](../Model/Admission.md)
110+
111+
### Authorization
112+
113+
[bearer](../../README.md#bearer)
114+
115+
### HTTP request headers
116+
117+
- **Content-Type**: Not defined
118+
- **Accept**: application/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+
122+
# **apiAdmissionsIdPut**
123+
> \Yoast\MyYoastApiClient\Model\Admission apiAdmissionsIdPut($body, $id)
124+
125+
Update an admission
126+
127+
Changes the student for a certain admission
128+
129+
### Example
130+
```php
131+
<?php
132+
require_once(__DIR__ . '/vendor/autoload.php');
133+
// Configure API key authorization: bearer
134+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
135+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
136+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
137+
138+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
139+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
140+
// This is optional, `GuzzleHttp\Client` will be used as default.
141+
new GuzzleHttp\Client(),
142+
$config
143+
);
144+
$body = new \Yoast\MyYoastApiClient\Model\UpdateDto(); // \Yoast\MyYoastApiClient\Model\UpdateDto |
145+
$id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
146+
147+
try {
148+
$result = $apiInstance->apiAdmissionsIdPut($body, $id);
149+
print_r($result);
150+
} catch (Exception $e) {
151+
echo 'Exception when calling AdmissionApi->apiAdmissionsIdPut: ', $e->getMessage(), PHP_EOL;
152+
}
153+
?>
154+
```
155+
156+
### Parameters
157+
158+
Name | Type | Description | Notes
159+
------------- | ------------- | ------------- | -------------
160+
**body** | [**\Yoast\MyYoastApiClient\Model\UpdateDto**](../Model/UpdateDto.md)| |
161+
**id** | [**string**](../Model/.md)| |
162+
163+
### Return type
164+
165+
[**\Yoast\MyYoastApiClient\Model\Admission**](../Model/Admission.md)
166+
167+
### Authorization
168+
169+
[bearer](../../README.md#bearer)
170+
171+
### HTTP request headers
172+
173+
- **Content-Type**: application/json
174+
- **Accept**: application/json
175+
176+
[[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)
177+
178+
# **apiAdmissionsPagedGet**
179+
> apiAdmissionsPagedGet($filter)
180+
181+
Get admissions
182+
183+
Get and filter admissions
184+
185+
### Example
186+
```php
187+
<?php
188+
require_once(__DIR__ . '/vendor/autoload.php');
189+
// Configure API key authorization: bearer
190+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
191+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
192+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
193+
194+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
195+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
196+
// This is optional, `GuzzleHttp\Client` will be used as default.
197+
new GuzzleHttp\Client(),
198+
$config
199+
);
200+
$filter = new \stdClass; // object | Used for filtering/joining the results.
201+
202+
try {
203+
$apiInstance->apiAdmissionsPagedGet($filter);
204+
} catch (Exception $e) {
205+
echo 'Exception when calling AdmissionApi->apiAdmissionsPagedGet: ', $e->getMessage(), PHP_EOL;
206+
}
207+
?>
208+
```
209+
210+
### Parameters
211+
212+
Name | Type | Description | Notes
213+
------------- | ------------- | ------------- | -------------
214+
**filter** | [**object**](../Model/.md)| Used for filtering/joining the results. | [optional]
215+
216+
### Return type
217+
218+
void (empty response body)
219+
220+
### Authorization
221+
222+
[bearer](../../README.md#bearer)
223+
224+
### HTTP request headers
225+
226+
- **Content-Type**: Not defined
227+
- **Accept**: Not defined
228+
229+
[[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)
230+
231+
# **apiAdmissionsPost**
232+
> \Yoast\MyYoastApiClient\Model\Admission apiAdmissionsPost($body)
233+
234+
Invite a customer
235+
236+
Invites another customer by email to use this admission
237+
238+
### Example
239+
```php
240+
<?php
241+
require_once(__DIR__ . '/vendor/autoload.php');
242+
// Configure API key authorization: bearer
243+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
244+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
245+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
246+
247+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
248+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
249+
// This is optional, `GuzzleHttp\Client` will be used as default.
250+
new GuzzleHttp\Client(),
251+
$config
252+
);
253+
$body = new \Yoast\MyYoastApiClient\Model\CreateDto(); // \Yoast\MyYoastApiClient\Model\CreateDto |
254+
255+
try {
256+
$result = $apiInstance->apiAdmissionsPost($body);
257+
print_r($result);
258+
} catch (Exception $e) {
259+
echo 'Exception when calling AdmissionApi->apiAdmissionsPost: ', $e->getMessage(), PHP_EOL;
260+
}
261+
?>
262+
```
263+
264+
### Parameters
265+
266+
Name | Type | Description | Notes
267+
------------- | ------------- | ------------- | -------------
268+
**body** | [**\Yoast\MyYoastApiClient\Model\CreateDto**](../Model/CreateDto.md)| |
269+
270+
### Return type
271+
272+
[**\Yoast\MyYoastApiClient\Model\Admission**](../Model/Admission.md)
273+
274+
### Authorization
275+
276+
[bearer](../../README.md#bearer)
277+
278+
### HTTP request headers
279+
280+
- **Content-Type**: application/json
281+
- **Accept**: application/json
282+
283+
[[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)
284+
285+
# **apiAdmissionsTransferPost**
286+
> \Yoast\MyYoastApiClient\Model\Admission[] apiAdmissionsTransferPost($body)
287+
288+
Transfer admissions between customers
289+
290+
Transfers all admission from one customer to another
291+
292+
### Example
293+
```php
294+
<?php
295+
require_once(__DIR__ . '/vendor/autoload.php');
296+
// Configure API key authorization: bearer
297+
$config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKey('access_token', 'YOUR_API_KEY');
298+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
299+
// $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('access_token', 'Bearer');
300+
301+
$apiInstance = new Yoast\MyYoastApiClient\Api\AdmissionApi(
302+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
303+
// This is optional, `GuzzleHttp\Client` will be used as default.
304+
new GuzzleHttp\Client(),
305+
$config
306+
);
307+
$body = new \Yoast\MyYoastApiClient\Model\TransferAdmissionDto(); // \Yoast\MyYoastApiClient\Model\TransferAdmissionDto |
308+
309+
try {
310+
$result = $apiInstance->apiAdmissionsTransferPost($body);
311+
print_r($result);
312+
} catch (Exception $e) {
313+
echo 'Exception when calling AdmissionApi->apiAdmissionsTransferPost: ', $e->getMessage(), PHP_EOL;
314+
}
315+
?>
316+
```
317+
318+
### Parameters
319+
320+
Name | Type | Description | Notes
321+
------------- | ------------- | ------------- | -------------
322+
**body** | [**\Yoast\MyYoastApiClient\Model\TransferAdmissionDto**](../Model/TransferAdmissionDto.md)| |
323+
324+
### Return type
325+
326+
[**\Yoast\MyYoastApiClient\Model\Admission[]**](../Model/Admission.md)
327+
328+
### Authorization
329+
330+
[bearer](../../README.md#bearer)
331+
332+
### HTTP request headers
333+
334+
- **Content-Type**: application/json
335+
- **Accept**: application/json
336+
337+
[[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)
338+

0 commit comments

Comments
 (0)