|
| 1 | +# cbeyersdorf\easybill\DocumentVersionApi |
| 2 | + |
| 3 | +All URIs are relative to https://api.easybill.de/rest/v1, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**documentsIdVersionsGet()**](DocumentVersionApi.md#documentsIdVersionsGet) | **GET** /documents/{id}/versions | List all versions of a given document | |
| 8 | +| [**documentsIdVersionsVersionIdGet()**](DocumentVersionApi.md#documentsIdVersionsVersionIdGet) | **GET** /documents/{id}/versions/{versionId} | Show a single version of a given document | |
| 9 | +| [**documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet()**](DocumentVersionApi.md#documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet) | **GET** /documents/{id}/versions/{versionId}/items/{versionItemId}/download | Download a specific file for a single version of a given document | |
| 10 | + |
| 11 | + |
| 12 | +## `documentsIdVersionsGet()` |
| 13 | + |
| 14 | +```php |
| 15 | +documentsIdVersionsGet($id, $limit, $page): \cbeyersdorf\easybill\Model\DocumentVersions |
| 16 | +``` |
| 17 | + |
| 18 | +List all versions of a given document |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | +```php |
| 23 | +<?php |
| 24 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 25 | + |
| 26 | + |
| 27 | +// Configure HTTP basic authorization: basicAuth |
| 28 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration() |
| 29 | + ->setUsername('YOUR_USERNAME') |
| 30 | + ->setPassword('YOUR_PASSWORD'); |
| 31 | + |
| 32 | +// Configure API key authorization: Bearer |
| 33 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 34 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 35 | +// $config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 36 | + |
| 37 | + |
| 38 | +$apiInstance = new cbeyersdorf\easybill\Api\DocumentVersionApi( |
| 39 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 40 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 41 | + new GuzzleHttp\Client(), |
| 42 | + $config |
| 43 | +); |
| 44 | +$id = 56; // int | ID of document |
| 45 | +$limit = 56; // int | Limited the result. Default is 100. Maximum can be 1000. |
| 46 | +$page = 56; // int | Set current Page. Default is 1. |
| 47 | + |
| 48 | +try { |
| 49 | + $result = $apiInstance->documentsIdVersionsGet($id, $limit, $page); |
| 50 | + print_r($result); |
| 51 | +} catch (Exception $e) { |
| 52 | + echo 'Exception when calling DocumentVersionApi->documentsIdVersionsGet: ', $e->getMessage(), PHP_EOL; |
| 53 | +} |
| 54 | +``` |
| 55 | + |
| 56 | +### Parameters |
| 57 | + |
| 58 | +| Name | Type | Description | Notes | |
| 59 | +| ------------- | ------------- | ------------- | ------------- | |
| 60 | +| **id** | **int**| ID of document | | |
| 61 | +| **limit** | **int**| Limited the result. Default is 100. Maximum can be 1000. | [optional] | |
| 62 | +| **page** | **int**| Set current Page. Default is 1. | [optional] | |
| 63 | + |
| 64 | +### Return type |
| 65 | + |
| 66 | +[**\cbeyersdorf\easybill\Model\DocumentVersions**](../Model/DocumentVersions.md) |
| 67 | + |
| 68 | +### Authorization |
| 69 | + |
| 70 | +[basicAuth](../../README.md#basicAuth), [Bearer](../../README.md#Bearer) |
| 71 | + |
| 72 | +### HTTP request headers |
| 73 | + |
| 74 | +- **Content-Type**: Not defined |
| 75 | +- **Accept**: `application/json` |
| 76 | + |
| 77 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 78 | +[[Back to Model list]](../../README.md#models) |
| 79 | +[[Back to README]](../../README.md) |
| 80 | + |
| 81 | +## `documentsIdVersionsVersionIdGet()` |
| 82 | + |
| 83 | +```php |
| 84 | +documentsIdVersionsVersionIdGet($id, $version_id): \cbeyersdorf\easybill\Model\DocumentVersion |
| 85 | +``` |
| 86 | + |
| 87 | +Show a single version of a given document |
| 88 | + |
| 89 | +### Example |
| 90 | + |
| 91 | +```php |
| 92 | +<?php |
| 93 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 94 | + |
| 95 | + |
| 96 | +// Configure HTTP basic authorization: basicAuth |
| 97 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration() |
| 98 | + ->setUsername('YOUR_USERNAME') |
| 99 | + ->setPassword('YOUR_PASSWORD'); |
| 100 | + |
| 101 | +// Configure API key authorization: Bearer |
| 102 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 103 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 104 | +// $config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 105 | + |
| 106 | + |
| 107 | +$apiInstance = new cbeyersdorf\easybill\Api\DocumentVersionApi( |
| 108 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 109 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 110 | + new GuzzleHttp\Client(), |
| 111 | + $config |
| 112 | +); |
| 113 | +$id = 56; // int | ID of document |
| 114 | +$version_id = 56; // int | ID of document version |
| 115 | + |
| 116 | +try { |
| 117 | + $result = $apiInstance->documentsIdVersionsVersionIdGet($id, $version_id); |
| 118 | + print_r($result); |
| 119 | +} catch (Exception $e) { |
| 120 | + echo 'Exception when calling DocumentVersionApi->documentsIdVersionsVersionIdGet: ', $e->getMessage(), PHP_EOL; |
| 121 | +} |
| 122 | +``` |
| 123 | + |
| 124 | +### Parameters |
| 125 | + |
| 126 | +| Name | Type | Description | Notes | |
| 127 | +| ------------- | ------------- | ------------- | ------------- | |
| 128 | +| **id** | **int**| ID of document | | |
| 129 | +| **version_id** | **int**| ID of document version | | |
| 130 | + |
| 131 | +### Return type |
| 132 | + |
| 133 | +[**\cbeyersdorf\easybill\Model\DocumentVersion**](../Model/DocumentVersion.md) |
| 134 | + |
| 135 | +### Authorization |
| 136 | + |
| 137 | +[basicAuth](../../README.md#basicAuth), [Bearer](../../README.md#Bearer) |
| 138 | + |
| 139 | +### HTTP request headers |
| 140 | + |
| 141 | +- **Content-Type**: Not defined |
| 142 | +- **Accept**: `application/json` |
| 143 | + |
| 144 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 145 | +[[Back to Model list]](../../README.md#models) |
| 146 | +[[Back to README]](../../README.md) |
| 147 | + |
| 148 | +## `documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet()` |
| 149 | + |
| 150 | +```php |
| 151 | +documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet($id, $version_id, $version_item_id): \SplFileObject |
| 152 | +``` |
| 153 | + |
| 154 | +Download a specific file for a single version of a given document |
| 155 | + |
| 156 | +### Example |
| 157 | + |
| 158 | +```php |
| 159 | +<?php |
| 160 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 161 | + |
| 162 | + |
| 163 | +// Configure HTTP basic authorization: basicAuth |
| 164 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration() |
| 165 | + ->setUsername('YOUR_USERNAME') |
| 166 | + ->setPassword('YOUR_PASSWORD'); |
| 167 | + |
| 168 | +// Configure API key authorization: Bearer |
| 169 | +$config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 170 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 171 | +// $config = cbeyersdorf\easybill\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 172 | + |
| 173 | + |
| 174 | +$apiInstance = new cbeyersdorf\easybill\Api\DocumentVersionApi( |
| 175 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 176 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 177 | + new GuzzleHttp\Client(), |
| 178 | + $config |
| 179 | +); |
| 180 | +$id = 56; // int | ID of document |
| 181 | +$version_id = 56; // int | ID of document version |
| 182 | +$version_item_id = 56; // int | ID of document version item |
| 183 | + |
| 184 | +try { |
| 185 | + $result = $apiInstance->documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet($id, $version_id, $version_item_id); |
| 186 | + print_r($result); |
| 187 | +} catch (Exception $e) { |
| 188 | + echo 'Exception when calling DocumentVersionApi->documentsIdVersionsVersionIdItemsVersionItemIdDownloadGet: ', $e->getMessage(), PHP_EOL; |
| 189 | +} |
| 190 | +``` |
| 191 | + |
| 192 | +### Parameters |
| 193 | + |
| 194 | +| Name | Type | Description | Notes | |
| 195 | +| ------------- | ------------- | ------------- | ------------- | |
| 196 | +| **id** | **int**| ID of document | | |
| 197 | +| **version_id** | **int**| ID of document version | | |
| 198 | +| **version_item_id** | **int**| ID of document version item | | |
| 199 | + |
| 200 | +### Return type |
| 201 | + |
| 202 | +**\SplFileObject** |
| 203 | + |
| 204 | +### Authorization |
| 205 | + |
| 206 | +[basicAuth](../../README.md#basicAuth), [Bearer](../../README.md#Bearer) |
| 207 | + |
| 208 | +### HTTP request headers |
| 209 | + |
| 210 | +- **Content-Type**: Not defined |
| 211 | +- **Accept**: `application/pdf`, `text/xml` |
| 212 | + |
| 213 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 214 | +[[Back to Model list]](../../README.md#models) |
| 215 | +[[Back to README]](../../README.md) |
0 commit comments