diff --git a/README.md b/README.md index 7c4627f..b9c11f1 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ vendor/bin/phpunit This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: `0.4.1` - - Package version: `2.1.3` +- API version: `0.4.4-alpha.4` + - Package version: `2.1.4` - Generator version: `7.6.0` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/composer.json b/composer.json index 5135a93..c7f2198 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "databox/databox", - "version": "2.1.3", + "version": "2.1.4", "description": "Push API resources Open API documentation", "keywords": [ "openapitools", diff --git a/docs/Api/DefaultApi.md b/docs/Api/DefaultApi.md new file mode 100644 index 0000000..0ee65b8 --- /dev/null +++ b/docs/Api/DefaultApi.md @@ -0,0 +1,358 @@ +# Databox\DefaultApi + +All URIs are relative to https://push.databox.com, except if the operation defines another base path. + +| Method | HTTP request | Description | +| ------------- | ------------- | ------------- | +| [**dataDelete()**](DefaultApi.md#dataDelete) | **DELETE** /data | | +| [**dataMetricKeyDelete()**](DefaultApi.md#dataMetricKeyDelete) | **DELETE** /data/{metricKey} | | +| [**dataPost()**](DefaultApi.md#dataPost) | **POST** /data | | +| [**metrickeysGet()**](DefaultApi.md#metrickeysGet) | **GET** /metrickeys | | +| [**metrickeysPost()**](DefaultApi.md#metrickeysPost) | **POST** /metrickeys | | +| [**pingGet()**](DefaultApi.md#pingGet) | **GET** /ping | | + + +## `dataDelete()` + +```php +dataDelete() +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $apiInstance->dataDelete(); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->dataDelete: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `dataMetricKeyDelete()` + +```php +dataMetricKeyDelete($metric_key) +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$metric_key = 'metric_key_example'; // string + +try { + $apiInstance->dataMetricKeyDelete($metric_key); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->dataMetricKeyDelete: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **metric_key** | **string**| | | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `dataPost()` + +```php +dataPost($push_data) +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$push_data = array(new \Databox\Model\PushData()); // \Databox\Model\PushData[] + +try { + $apiInstance->dataPost($push_data); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->dataPost: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **push_data** | [**\Databox\Model\PushData[]**](../Model/PushData.md)| | [optional] | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: `application/json`, `application/vnd.databox.v2+json` +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `metrickeysGet()` + +```php +metrickeysGet() +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $apiInstance->metrickeysGet(); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->metrickeysGet: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `metrickeysPost()` + +```php +metrickeysPost($body) +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); +$body = array('key' => new \stdClass); // object + +try { + $apiInstance->metrickeysPost($body); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->metrickeysPost: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **body** | **object**| | [optional] | + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: `application/json`, `application/vnd.databox.v2+json` +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) + +## `pingGet()` + +```php +pingGet() +``` + + + +### Example + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $apiInstance->pingGet(); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->pingGet: ', $e->getMessage(), PHP_EOL; +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[basicAuth](../../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to Model list]](../../README.md#models) +[[Back to README]](../../README.md) diff --git a/docs/Model/ApiResponse.md b/docs/Model/ApiResponse.md new file mode 100644 index 0000000..a1d93e4 --- /dev/null +++ b/docs/Model/ApiResponse.md @@ -0,0 +1,10 @@ +# # ApiResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | | [optional] +**message** | **string** | | [optional] + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/PushData.md b/docs/Model/PushData.md new file mode 100644 index 0000000..8977a2d --- /dev/null +++ b/docs/Model/PushData.md @@ -0,0 +1,15 @@ +# # PushData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**\Databox\Model\PushDataAttribute[]**](PushDataAttribute.md) | | [optional] +**date** | **string** | | [optional] +**key** | **string** | | [optional] +**period_from** | **string** | | [optional] +**period_to** | **string** | | [optional] +**unit** | **string** | | [optional] +**value** | **float** | | [optional] + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/PushDataAttribute.md b/docs/Model/PushDataAttribute.md new file mode 100644 index 0000000..a0e0a5c --- /dev/null +++ b/docs/Model/PushDataAttribute.md @@ -0,0 +1,10 @@ +# # PushDataAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | | [optional] +**value** | **string** | | [optional] + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/State.md b/docs/Model/State.md new file mode 100644 index 0000000..cb2d4a7 --- /dev/null +++ b/docs/Model/State.md @@ -0,0 +1,8 @@ +# # State + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/src/README.md b/src/README.md index 7c4627f..b9c11f1 100644 --- a/src/README.md +++ b/src/README.md @@ -114,7 +114,7 @@ vendor/bin/phpunit This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: `0.4.1` - - Package version: `2.1.3` +- API version: `0.4.4-alpha.4` + - Package version: `2.1.4` - Generator version: `7.6.0` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/src/composer.json b/src/composer.json index 5135a93..c7f2198 100644 --- a/src/composer.json +++ b/src/composer.json @@ -1,6 +1,6 @@ { "name": "databox/databox", - "version": "2.1.3", + "version": "2.1.4", "description": "Push API resources Open API documentation", "keywords": [ "openapitools", diff --git a/src/lib/Api/DefaultApi.php b/src/lib/Api/DefaultApi.php index ed4a597..fa54a4c 100644 --- a/src/lib/Api/DefaultApi.php +++ b/src/lib/Api/DefaultApi.php @@ -14,7 +14,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/ApiException.php b/src/lib/ApiException.php index ec355c0..78a497e 100644 --- a/src/lib/ApiException.php +++ b/src/lib/ApiException.php @@ -14,7 +14,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Configuration.php b/src/lib/Configuration.php index bc3bde0..f7719ad 100644 --- a/src/lib/Configuration.php +++ b/src/lib/Configuration.php @@ -14,7 +14,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ @@ -100,7 +100,7 @@ class Configuration * * @var string */ - protected $userAgent = 'OpenAPI-Generator/2.1.3/PHP'; + protected $userAgent = 'OpenAPI-Generator/2.1.4/PHP'; /** * Debug switch (default set to false) @@ -432,8 +432,8 @@ public static function toDebugReport() $report = 'PHP SDK (Databox) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; - $report .= ' The version of the OpenAPI document: 0.4.1' . PHP_EOL; - $report .= ' SDK Package Version: 2.1.3' . PHP_EOL; + $report .= ' The version of the OpenAPI document: 0.4.4-alpha.4' . PHP_EOL; + $report .= ' SDK Package Version: 2.1.4' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/src/lib/HeaderSelector.php b/src/lib/HeaderSelector.php index 2490580..921f40e 100644 --- a/src/lib/HeaderSelector.php +++ b/src/lib/HeaderSelector.php @@ -14,7 +14,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Model/ApiResponse.php b/src/lib/Model/ApiResponse.php index 3521778..687fc1a 100644 --- a/src/lib/Model/ApiResponse.php +++ b/src/lib/Model/ApiResponse.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Model/ModelInterface.php b/src/lib/Model/ModelInterface.php index 0decf25..c7a6ab8 100644 --- a/src/lib/Model/ModelInterface.php +++ b/src/lib/Model/ModelInterface.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Model/PushData.php b/src/lib/Model/PushData.php index 8459d1c..0630d08 100644 --- a/src/lib/Model/PushData.php +++ b/src/lib/Model/PushData.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Model/PushDataAttribute.php b/src/lib/Model/PushDataAttribute.php index 2d75719..38677df 100644 --- a/src/lib/Model/PushDataAttribute.php +++ b/src/lib/Model/PushDataAttribute.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/Model/State.php b/src/lib/Model/State.php index 73d3c8b..b6ea432 100644 --- a/src/lib/Model/State.php +++ b/src/lib/Model/State.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/lib/ObjectSerializer.php b/src/lib/ObjectSerializer.php index 2cd843b..8aa8e6e 100644 --- a/src/lib/ObjectSerializer.php +++ b/src/lib/ObjectSerializer.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/test/Api/DefaultApiTest.php b/src/test/Api/DefaultApiTest.php index 6f56abb..cbd8178 100644 --- a/src/test/Api/DefaultApiTest.php +++ b/src/test/Api/DefaultApiTest.php @@ -14,7 +14,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/test/Model/ApiResponseTest.php b/src/test/Model/ApiResponseTest.php index b26c0b3..743b042 100644 --- a/src/test/Model/ApiResponseTest.php +++ b/src/test/Model/ApiResponseTest.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/test/Model/PushDataAttributeTest.php b/src/test/Model/PushDataAttributeTest.php index 3a99683..d135c47 100644 --- a/src/test/Model/PushDataAttributeTest.php +++ b/src/test/Model/PushDataAttributeTest.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/test/Model/PushDataTest.php b/src/test/Model/PushDataTest.php index ff1c284..98b9838 100644 --- a/src/test/Model/PushDataTest.php +++ b/src/test/Model/PushDataTest.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */ diff --git a/src/test/Model/StateTest.php b/src/test/Model/StateTest.php index b4ecab4..faf8b09 100644 --- a/src/test/Model/StateTest.php +++ b/src/test/Model/StateTest.php @@ -15,7 +15,7 @@ * * Push API resources Open API documentation * - * The version of the OpenAPI document: 0.4.1 + * The version of the OpenAPI document: 0.4.4-alpha.4 * Generated by: https://openapi-generator.tech * Generator version: 7.6.0 */