SematextCloud 0.1.5 → 0.4.0

data/docs/MetricsApi.md

@@ -1,227 +0,0 @@
-# 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

data/docs/SavedQueriesApi.md

@@ -1,220 +0,0 @@
-# SematextCloud::SavedQueriesApi
-
-All URIs are relative to *https://localhost*
-
-| Method                                                                                            | HTTP request                                                  | Description                  |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------- |
-| [**delete_saved_query_using_delete**](SavedQueriesApi.md#delete_saved_query_using_delete)         | **DELETE** /users-web/api/v3/savedQueries/{updateableQueryId} | Delete saved query           |
-| [**get_saved_queries_for_app_using_get**](SavedQueriesApi.md#get_saved_queries_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/savedQueries           | Get saved queries for an app |
-| [**save_query_using_post**](SavedQueriesApi.md#save_query_using_post)                             | **POST** /users-web/api/v3/savedQueries                       | Create saved query           |
-| [**save_query_using_put**](SavedQueriesApi.md#save_query_using_put)                               | **PUT** /users-web/api/v3/savedQueries/{updateableQueryId}    | Update saved query           |
-
-
-# **delete_saved_query_using_delete**
-> GenericApiResponse delete_saved_query_using_delete(updateable_query_id)
-
-Delete saved query
-
-### 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::SavedQueriesApi.new
-
-updateable_query_id = 789 # Integer | updateableQueryId
-
-
-begin
-  #Delete saved query
-  result = api_instance.delete_saved_query_using_delete(updateable_query_id)
-  p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SavedQueriesApi->delete_saved_query_using_delete: #{e}"
-end
-```
-
-### Parameters
-
-| Name                    | Type        | Description       | Notes |
-| ----------------------- | ----------- | ----------------- | ----- |
-| **updateable_query_id** | **Integer** | updateableQueryId |
-
-### Return type
-
-[**GenericApiResponse**](GenericApiResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_saved_queries_for_app_using_get**
-> GenericApiResponse get_saved_queries_for_app_using_get(app_id)
-
-Get saved queries 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::SavedQueriesApi.new
-
-app_id = 789 # Integer | appId
-
-
-begin
-  #Get saved queries for an app
-  result = api_instance.get_saved_queries_for_app_using_get(app_id)
-  p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SavedQueriesApi->get_saved_queries_for_app_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
-
-
-
-# **save_query_using_post**
-> GenericApiResponse save_query_using_post(saved_query_dto)
-
-Create saved query
-
-### 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::SavedQueriesApi.new
-
-saved_query_dto = SematextCloud::SavedQuery.new # SavedQuery | savedQueryDto
-
-
-begin
-  #Create saved query
-  result = api_instance.save_query_using_post(saved_query_dto)
-  p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SavedQueriesApi->save_query_using_post: #{e}"
-end
-```
-
-### Parameters
-
-| Name                | Type                            | Description   | Notes |
-| ------------------- | ------------------------------- | ------------- | ----- |
-| **saved_query_dto** | [**SavedQuery**](SavedQuery.md) | savedQueryDto |
-
-### Return type
-
-[**GenericApiResponse**](GenericApiResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **save_query_using_put**
-> GenericApiResponse save_query_using_put(saved_query_dto, updateable_query_id)
-
-Update saved query
-
-### 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::SavedQueriesApi.new
-
-saved_query_dto = SematextCloud::SavedQuery.new # SavedQuery | savedQueryDto
-
-updateable_query_id = 789 # Integer | updateableQueryId
-
-
-begin
-  #Update saved query
-  result = api_instance.save_query_using_put(saved_query_dto, updateable_query_id)
-  p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SavedQueriesApi->save_query_using_put: #{e}"
-end
-```
-
-### Parameters
-
-| Name                    | Type                            | Description       | Notes |
-| ----------------------- | ------------------------------- | ----------------- | ----- |
-| **saved_query_dto**     | [**SavedQuery**](SavedQuery.md) | savedQueryDto     |
-| **updateable_query_id** | **Integer**                     | updateableQueryId |
-
-### Return type
-
-[**GenericApiResponse**](GenericApiResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json

data/docs/SavedQuery.md

@@ -1,18 +0,0 @@
-# SematextCloud::SavedQuery
-
-## Properties
-| Name                   | Type                                      | Description | Notes      |
-| ---------------------- | ----------------------------------------- | ----------- | ---------- |
-| **alert_rule**         | [**AlertRule**](AlertRule.md)             |             | [optional] |
-| **allow_modification** | **BOOLEAN**                               |             | [optional] |
-| **application_id**     | **String**                                |             | [optional] |
-| **application_name**   | **String**                                |             | [optional] |
-| **application_token**  | **String**                                |             | [optional] |
-| **creator_email**      | **String**                                |             | [optional] |
-| **id**                 | **String**                                |             | [optional] |
-| **label_color**        | **String**                                |             | [optional] |
-| **logsene_alert_type** | **Object**                                |             | [optional] |
-| **owner_email**        | **String**                                |             | [optional] |
-| **query_name**         | **String**                                |             | [optional] |
-| **query_string**       | **String**                                |             | [optional] |
-| **user_permissions**   | [**UserPermissions**](UserPermissions.md) |             | [optional] |