diff --git a/README.md b/README.md index 1202698..5da2bb4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Push API resources Open API documentation This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 0.4.1 +- API version: 0.4.4-alpha.3 - Package version: 2.1.1 - Generator version: 7.6.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen diff --git a/docs/ApiResponse.md b/docs/ApiResponse.md new file mode 100644 index 0000000..5318886 --- /dev/null +++ b/docs/ApiResponse.md @@ -0,0 +1,20 @@ +# Databox::ApiResponse + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **status** | **String** | | [optional] | +| **message** | **String** | | [optional] | + +## Example + +```ruby +require 'databox' + +instance = Databox::ApiResponse.new( + status: null, + message: null +) +``` + diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md new file mode 100644 index 0000000..a4631cc --- /dev/null +++ b/docs/DefaultApi.md @@ -0,0 +1,410 @@ +# Databox::DefaultApi + +All URIs are relative to *https://push.databox.com* + +| Method | HTTP request | Description | +| ------ | ------------ | ----------- | +| [**data_delete**](DefaultApi.md#data_delete) | **DELETE** /data | | +| [**data_metric_key_delete**](DefaultApi.md#data_metric_key_delete) | **DELETE** /data/{metricKey} | | +| [**data_post**](DefaultApi.md#data_post) | **POST** /data | | +| [**metrickeys_get**](DefaultApi.md#metrickeys_get) | **GET** /metrickeys | | +| [**metrickeys_post**](DefaultApi.md#metrickeys_post) | **POST** /metrickeys | | +| [**ping_get**](DefaultApi.md#ping_get) | **GET** /ping | | + + +## data_delete + +> data_delete + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new + +begin + + api_instance.data_delete +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_delete: #{e}" +end +``` + +#### Using the data_delete_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> data_delete_with_http_info + +```ruby +begin + + data, status_code, headers = api_instance.data_delete_with_http_info + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_delete_with_http_info: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## data_metric_key_delete + +> data_metric_key_delete(metric_key) + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new +metric_key = 'metric_key_example' # String | + +begin + + api_instance.data_metric_key_delete(metric_key) +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_metric_key_delete: #{e}" +end +``` + +#### Using the data_metric_key_delete_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> data_metric_key_delete_with_http_info(metric_key) + +```ruby +begin + + data, status_code, headers = api_instance.data_metric_key_delete_with_http_info(metric_key) + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_metric_key_delete_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **metric_key** | **String** | | | + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## data_post + +> data_post(opts) + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new +opts = { + push_data: [Databox::PushData.new] # Array | +} + +begin + + api_instance.data_post(opts) +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_post: #{e}" +end +``` + +#### Using the data_post_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> data_post_with_http_info(opts) + +```ruby +begin + + data, status_code, headers = api_instance.data_post_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->data_post_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **push_data** | [**Array<PushData>**](PushData.md) | | [optional] | + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: application/json, application/vnd.databox.v2+json +- **Accept**: Not defined + + +## metrickeys_get + +> metrickeys_get + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new + +begin + + api_instance.metrickeys_get +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->metrickeys_get: #{e}" +end +``` + +#### Using the metrickeys_get_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> metrickeys_get_with_http_info + +```ruby +begin + + data, status_code, headers = api_instance.metrickeys_get_with_http_info + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->metrickeys_get_with_http_info: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## metrickeys_post + +> metrickeys_post(opts) + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new +opts = { + body: { ... } # Object | +} + +begin + + api_instance.metrickeys_post(opts) +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->metrickeys_post: #{e}" +end +``` + +#### Using the metrickeys_post_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> metrickeys_post_with_http_info(opts) + +```ruby +begin + + data, status_code, headers = api_instance.metrickeys_post_with_http_info(opts) + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->metrickeys_post_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **body** | **Object** | | [optional] | + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: application/json, application/vnd.databox.v2+json +- **Accept**: Not defined + + +## ping_get + +> ping_get + + + +### Examples + +```ruby +require 'time' +require 'databox' +# setup authorization +Databox.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = Databox::DefaultApi.new + +begin + + api_instance.ping_get +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->ping_get: #{e}" +end +``` + +#### Using the ping_get_with_http_info variant + +This returns an Array which contains the response data (`nil` in this case), status code and headers. + +> ping_get_with_http_info + +```ruby +begin + + data, status_code, headers = api_instance.ping_get_with_http_info + p status_code # => 2xx + p headers # => { ... } + p data # => nil +rescue Databox::ApiError => e + puts "Error when calling DefaultApi->ping_get_with_http_info: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +nil (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + diff --git a/docs/PushData.md b/docs/PushData.md new file mode 100644 index 0000000..87f09a5 --- /dev/null +++ b/docs/PushData.md @@ -0,0 +1,30 @@ +# Databox::PushData + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **attributes** | [**Array<PushDataAttribute>**](PushDataAttribute.md) | | [optional] | +| **date** | **String** | | [optional] | +| **key** | **String** | | [optional] | +| **period_from** | **String** | | [optional] | +| **period_to** | **String** | | [optional] | +| **unit** | **String** | | [optional] | +| **value** | **Float** | | [optional] | + +## Example + +```ruby +require 'databox' + +instance = Databox::PushData.new( + attributes: null, + date: null, + key: null, + period_from: null, + period_to: null, + unit: null, + value: null +) +``` + diff --git a/docs/PushDataAttribute.md b/docs/PushDataAttribute.md new file mode 100644 index 0000000..2cd4b66 --- /dev/null +++ b/docs/PushDataAttribute.md @@ -0,0 +1,20 @@ +# Databox::PushDataAttribute + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **key** | **String** | | [optional] | +| **value** | **String** | | [optional] | + +## Example + +```ruby +require 'databox' + +instance = Databox::PushDataAttribute.new( + key: null, + value: null +) +``` + diff --git a/docs/State.md b/docs/State.md new file mode 100644 index 0000000..cb4f8e2 --- /dev/null +++ b/docs/State.md @@ -0,0 +1,15 @@ +# Databox::State + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | + +## Example + +```ruby +require 'databox' + +instance = Databox::State.new() +``` + diff --git a/src/README.md b/src/README.md index 492eebe..5da2bb4 100644 --- a/src/README.md +++ b/src/README.md @@ -6,8 +6,8 @@ Push API resources Open API documentation This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 0.4.1 -- Package version: 2.1.1 +- API version: 0.4.4-alpha.3 +- Package version: 2.1.1 - Generator version: 7.6.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen diff --git a/src/databox.gemspec b/src/databox.gemspec index 3cbfaec..f238884 100644 --- a/src/databox.gemspec +++ b/src/databox.gemspec @@ -5,7 +5,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox.rb b/src/lib/databox.rb index b6a57cb..38b1e01 100644 --- a/src/lib/databox.rb +++ b/src/lib/databox.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/api/default_api.rb b/src/lib/databox/api/default_api.rb index 4adda3f..65d4e07 100644 --- a/src/lib/databox/api/default_api.rb +++ b/src/lib/databox/api/default_api.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/api_client.rb b/src/lib/databox/api_client.rb index 302cc06..315b6cb 100644 --- a/src/lib/databox/api_client.rb +++ b/src/lib/databox/api_client.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/api_error.rb b/src/lib/databox/api_error.rb index ce9f665..7f1a0e2 100644 --- a/src/lib/databox/api_error.rb +++ b/src/lib/databox/api_error.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/configuration.rb b/src/lib/databox/configuration.rb index 19b9b13..3c2aa90 100644 --- a/src/lib/databox/configuration.rb +++ b/src/lib/databox/configuration.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/models/api_response.rb b/src/lib/databox/models/api_response.rb index 6c03ac6..9c34b96 100644 --- a/src/lib/databox/models/api_response.rb +++ b/src/lib/databox/models/api_response.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/models/push_data.rb b/src/lib/databox/models/push_data.rb index 5def2d9..124f515 100644 --- a/src/lib/databox/models/push_data.rb +++ b/src/lib/databox/models/push_data.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/models/push_data_attribute.rb b/src/lib/databox/models/push_data_attribute.rb index cc3a5e7..44d5064 100644 --- a/src/lib/databox/models/push_data_attribute.rb +++ b/src/lib/databox/models/push_data_attribute.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/models/state.rb b/src/lib/databox/models/state.rb index 4f4d3a5..76fd3a9 100644 --- a/src/lib/databox/models/state.rb +++ b/src/lib/databox/models/state.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/lib/databox/version.rb b/src/lib/databox/version.rb index 58fcc88..b78c44a 100644 --- a/src/lib/databox/version.rb +++ b/src/lib/databox/version.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/api/default_api_spec.rb b/src/spec/api/default_api_spec.rb index 83a256b..a7aa4ec 100644 --- a/src/spec/api/default_api_spec.rb +++ b/src/spec/api/default_api_spec.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/models/api_response_spec.rb b/src/spec/models/api_response_spec.rb index 30b6745..69b5735 100644 --- a/src/spec/models/api_response_spec.rb +++ b/src/spec/models/api_response_spec.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/models/push_data_attribute_spec.rb b/src/spec/models/push_data_attribute_spec.rb index 69dd09d..a1ee9ac 100644 --- a/src/spec/models/push_data_attribute_spec.rb +++ b/src/spec/models/push_data_attribute_spec.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/models/push_data_spec.rb b/src/spec/models/push_data_spec.rb index a87b991..5028cec 100644 --- a/src/spec/models/push_data_spec.rb +++ b/src/spec/models/push_data_spec.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/models/state_spec.rb b/src/spec/models/state_spec.rb index 966baaa..c37c666 100644 --- a/src/spec/models/state_spec.rb +++ b/src/spec/models/state_spec.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0 diff --git a/src/spec/spec_helper.rb b/src/spec/spec_helper.rb index ff3343d..bcf3b14 100644 --- a/src/spec/spec_helper.rb +++ b/src/spec/spec_helper.rb @@ -3,7 +3,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.3 Generated by: https://openapi-generator.tech Generator version: 7.6.0