SematextCloud 0.1.0

data/docs/BasicAuthMethodDto.md

@@ -0,0 +1,7 @@
+# SematextCloud::BasicAuthMethodDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_type** | **String** |  | [optional]
+**uuid** | **String** |  | [optional]

data/docs/BasicOrganizationDto.md

@@ -0,0 +1,9 @@
+# SematextCloud::BasicOrganizationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) |  | [optional]
+**name** | **String** |  | [optional]
+**status** | **String** |  | [optional]
+**uuid** | **String** |  | [optional]

data/docs/BillingApi.md

@@ -0,0 +1,176 @@
+# SematextCloud::BillingApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details
+[**list_available_plans_using_get**](BillingApi.md#list_available_plans_using_get) | **GET** /users-web/api/v3/billing/availablePlans | Get available plans
+[**update_plan_using_put**](BillingApi.md#update_plan_using_put) | **PUT** /users-web/api/v3/billing/info/{appId} | Update plan for an app
+
+
+# **get_detailed_invoice_using_get**
+> GenericApiResponse get_detailed_invoice_using_get(service, year, month)
+
+Get invoice details
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::BillingApi.new
+
+service = 'service_example' # String | service
+
+year = 56 # Integer | year
+
+month = 56 # Integer | month
+
+
+begin
+  #Get invoice details
+  result = api_instance.get_detailed_invoice_using_get(service, year, month)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling BillingApi->get_detailed_invoice_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service** | **String**| service |
+ **year** | **Integer**| year |
+ **month** | **Integer**| month |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_available_plans_using_get**
+> GenericApiResponse list_available_plans_using_get(opts)
+
+Get available plans
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::BillingApi.new
+
+opts = {
+  integration_id: 789, # Integer | integrationId
+  app_type: 'app_type_example' # String | appType
+}
+
+begin
+  #Get available plans
+  result = api_instance.list_available_plans_using_get(opts)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling BillingApi->list_available_plans_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **Integer**| integrationId | [optional]
+ **app_type** | **String**| appType | [optional]
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_plan_using_put**
+> GenericApiResponse update_plan_using_put(app_id, dto)
+
+Update plan for an app
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::BillingApi.new
+
+app_id = 789 # Integer | appId
+
+dto = SematextCloud::BillingInfo.new # BillingInfo | dto
+
+
+begin
+  #Update plan for an app
+  result = api_instance.update_plan_using_put(app_id, dto)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling BillingApi->update_plan_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+ **dto** | [**BillingInfo**](BillingInfo.md)| dto |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json

data/docs/BillingInfo.md

@@ -0,0 +1,8 @@
+# SematextCloud::BillingInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credit_card_id** | **Integer** |  | [optional]
+**payment_method** | **String** |  | [optional]
+**plan_id** | **Integer** |  | [optional]

data/docs/CloudWatchSettings.md

@@ -0,0 +1,9 @@
+# SematextCloud::CloudWatchSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_key** | **String** |  | [optional]
+**fetch_frequency** | **String** |  | [optional]
+**region** | **String** |  | [optional]
+**secret_key** | **String** |  | [optional]

data/docs/CreateAppInfo.md

@@ -0,0 +1,10 @@
+# SematextCloud::CreateAppInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_type** | **String** |  | [optional]
+**discount_code** | **String** |  | [optional]
+**initial_plan_id** | **Integer** |  | [optional]
+**meta_data** | [**AppMetadata**](AppMetadata.md) | AWS app meta data. Applicable only for `aws` appType | [optional]
+**name** | **String** |  | [optional]

data/docs/DataSeriesFilter.md

@@ -0,0 +1,8 @@
+# SematextCloud::DataSeriesFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation** | **String** |  | [optional]
+**multi_value** | **BOOLEAN** |  | [optional]
+**values** | **Array<String>** |  | [optional]

data/docs/DataSeriesRequest.md

@@ -0,0 +1,12 @@
+# SematextCloud::DataSeriesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_interval** | **Integer** |  | [optional]
+**_end** | **String** | End time of interval. Can be expressed as timestamp in milliseconds or UTC date in yyyy-MM-dd HH:mm:ss format | [optional]
+**filters** | [**Hash<String, DataSeriesFilter>**](DataSeriesFilter.md) | Map of allowed filter values and aggregation strategy. List of available filter values can be fetched using metric filters endpoint and default aggregation strategy depends on metric | [optional]
+**granularity** | **String** | Data points interval granularity between two data points.Default value is \"AUTO\" - calculated based on selected time span. Not required while getting filters. | [optional]
+**interval** | **String** |  | [optional]
+**metric** | **String** | Metric name or metric group prefix |
+**start** | **String** | Start time of interval. Can be expressed as timestamp in milliseconds or UTC date in yyyy-MM-dd HH:mm:ss format | [optional]

data/docs/Error.md

@@ -0,0 +1,7 @@
+# SematextCloud::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional]
+**message** | **String** |  | [optional]

data/docs/FilterValue.md

@@ -0,0 +1,11 @@
+# SematextCloud::FilterValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agg_type** | **String** |  | [optional]
+**filter_name** | **String** |  | [optional]
+**key** | **String** |  | [optional]
+**label** | **String** |  | [optional]
+**name** | **String** |  | [optional]
+**values** | **Array<String>** |  | [optional]

data/docs/GenericApiResponse.md

@@ -0,0 +1,9 @@
+# SematextCloud::GenericApiResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Object** | Contains actual data when response is successful. Key and Value is specific to each endpoint | [optional]
+**errors** | [**Array<Error>**](Error.md) |  | [optional]
+**message** | **String** |  | [optional]
+**success** | **BOOLEAN** |  | [optional]

data/docs/Invitation.md

@@ -0,0 +1,15 @@
+# SematextCloud::Invitation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app** | [**App**](App.md) | For invite request, only app.id needs to be set. | [optional]
+**apps** | [**Array<App>**](App.md) | For invite request, only apps.id needs to be set. | [optional]
+**id** | **Integer** |  | [optional]
+**invite_date** | **DateTime** |  | [optional]
+**invite_status** | **String** |  | [optional]
+**invitee_email** | **String** |  | [optional]
+**invitee_role** | **String** |  | [optional]
+**invitee_status** | **String** |  | [optional]
+**inviter_email** | **String** |  | [optional]
+**uuid** | **String** |  | [optional]

data/docs/LogsAppApi.md

@@ -0,0 +1,58 @@
+# SematextCloud::LogsAppApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_logsene_application**](LogsAppApi.md#create_logsene_application) | **POST** /logsene-reports/api/v3/apps | Create Logs App
+
+
+# **create_logsene_application**
+> GenericApiResponse create_logsene_application(application_details)
+
+Create Logs App
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::LogsAppApi.new
+
+application_details = SematextCloud::CreateAppInfo.new # CreateAppInfo | Details of the application to be created
+
+
+begin
+  #Create Logs App
+  result = api_instance.create_logsene_application(application_details)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling LogsAppApi->create_logsene_application: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **application_details** | [**CreateAppInfo**](CreateAppInfo.md)| Details of the application to be created |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json

data/docs/MetricsApi.md

@@ -0,0 +1,227 @@
+# SematextCloud::MetricsApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_data_series_using_post**](MetricsApi.md#list_data_series_using_post) | **POST** /spm-reports/api/v3/apps/{appId}/metrics/data | Get metrics data points for an app
+[**list_filters_using_post**](MetricsApi.md#list_filters_using_post) | **POST** /spm-reports/api/v3/apps/{appId}/metrics/filters | Get metrics filters and their values for an app
+[**list_metrics_keys_using_get**](MetricsApi.md#list_metrics_keys_using_get) | **GET** /spm-reports/api/v3/apps/{appId}/metrics/keys | Get metrics keys for an app
+[**list_metrics_using_get**](MetricsApi.md#list_metrics_using_get) | **GET** /spm-reports/api/v3/apps/{appId}/metrics | Get metrics info for an app
+
+
+# **list_data_series_using_post**
+> GenericApiResponse list_data_series_using_post(app_id, request_body)
+
+Get metrics data points for an app
+
+Default value of interval is 5m
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::MetricsApi.new
+
+app_id = 789 # Integer | appId
+
+request_body = SematextCloud::DataSeriesRequest.new # DataSeriesRequest | Metric data points request
+
+
+begin
+  #Get metrics data points for an app
+  result = api_instance.list_data_series_using_post(app_id, request_body)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling MetricsApi->list_data_series_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+ **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md)| Metric data points request |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_filters_using_post**
+> GenericApiResponse list_filters_using_post(app_id, request_body)
+
+Get metrics filters and their values for an app
+
+Default value of interval is 5m
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::MetricsApi.new
+
+app_id = 789 # Integer | appId
+
+request_body = SematextCloud::DataSeriesRequest.new # DataSeriesRequest | Metric filters request
+
+
+begin
+  #Get metrics filters and their values for an app
+  result = api_instance.list_filters_using_post(app_id, request_body)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling MetricsApi->list_filters_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+ **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md)| Metric filters request |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_metrics_keys_using_get**
+> GenericApiResponse list_metrics_keys_using_get(app_id)
+
+Get metrics keys for an app
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::MetricsApi.new
+
+app_id = 789 # Integer | appId
+
+
+begin
+  #Get metrics keys for an app
+  result = api_instance.list_metrics_keys_using_get(app_id)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling MetricsApi->list_metrics_keys_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_metrics_using_get**
+> GenericApiResponse list_metrics_using_get(app_id)
+
+Get metrics info for an app
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::MetricsApi.new
+
+app_id = 789 # Integer | appId
+
+
+begin
+  #Get metrics info for an app
+  result = api_instance.list_metrics_using_get(app_id)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling MetricsApi->list_metrics_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json