docs/AlertsApi.md in SematextCloud-0.2.0 vs docs/AlertsApi.md in SematextCloud-0.3.0
- old
+ new
@@ -1,58 +1,56 @@
-# SematextCloud::AlertsApi
+# stcloud::AlertsApi
-All URIs are relative to *https://localhost*
+All URIs are relative to */*
| Method | HTTP request | Description |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------- |
| [**create_alert_using_post**](AlertsApi.md#create_alert_using_post) | **POST** /users-web/api/v3/alerts | Create alert rule |
| [**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete) | **DELETE** /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule |
| [**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule |
| [**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule |
| [**get_alert_rules_for_app_using_get**](AlertsApi.md#get_alert_rules_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/alerts | Get alert rules for an app |
-
# **create_alert_using_post**
-> GenericApiResponse create_alert_using_post(dto)
+> AlertRuleResponse create_alert_using_post(body)
Create alert rule
### Example
```ruby
# load the gem
-require 'SematextCloud'
+require 'stcloud'
# setup authorization
-SematextCloud.configure do |config|
+stcloud.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::AlertsApi.new
+api_instance = stcloud::AlertsApi.new
+body = stcloud::AlertRule.new # AlertRule | dto
-dto = SematextCloud::AlertRule.new # AlertRule | dto
-
begin
#Create alert rule
- result = api_instance.create_alert_using_post(dto)
+ result = api_instance.create_alert_using_post(body)
p result
-rescue SematextCloud::ApiError => e
+rescue stcloud::ApiError => e
puts "Exception when calling AlertsApi->create_alert_using_post: #{e}"
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ------- | ----------------------------- | ----------- | ----- |
-| **dto** | [**AlertRule**](AlertRule.md) | dto |
+| Name | Type | Description | Notes |
+| -------- | ----------------------------- | ----------- | ----- |
+| **body** | [**AlertRule**](AlertRule.md) | dto |
### Return type
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AlertRuleResponse**](AlertRuleResponse.md)
### Authorization
[api_key](../README.md#api_key)
@@ -62,36 +60,35 @@
- **Accept**: application/json
# **delete_alert_rule_using_delete**
-> GenericApiResponse delete_alert_rule_using_delete(updateable_alert_id)
+> GenericMapBasedApiResponse delete_alert_rule_using_delete(updateable_alert_id)
Delete alert rule
### Example
```ruby
# load the gem
-require 'SematextCloud'
+require 'stcloud'
# setup authorization
-SematextCloud.configure do |config|
+stcloud.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::AlertsApi.new
-
+api_instance = stcloud::AlertsApi.new
updateable_alert_id = 789 # Integer | updateableAlertId
begin
#Delete alert rule
result = api_instance.delete_alert_rule_using_delete(updateable_alert_id)
p result
-rescue SematextCloud::ApiError => e
+rescue stcloud::ApiError => e
puts "Exception when calling AlertsApi->delete_alert_rule_using_delete: #{e}"
end
```
### Parameters
@@ -100,50 +97,49 @@
| ----------------------- | ----------- | ----------------- | ----- |
| **updateable_alert_id** | **Integer** | updateableAlertId |
### Return type
-[**GenericApiResponse**](GenericApiResponse.md)
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
# **disable_alert_rule_using_put**
-> GenericApiResponse disable_alert_rule_using_put(updateable_alert_id)
+> GenericMapBasedApiResponse disable_alert_rule_using_put(updateable_alert_id)
Disable alert rule
### Example
```ruby
# load the gem
-require 'SematextCloud'
+require 'stcloud'
# setup authorization
-SematextCloud.configure do |config|
+stcloud.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::AlertsApi.new
-
+api_instance = stcloud::AlertsApi.new
updateable_alert_id = 789 # Integer | updateableAlertId
begin
#Disable alert rule
result = api_instance.disable_alert_rule_using_put(updateable_alert_id)
p result
-rescue SematextCloud::ApiError => e
+rescue stcloud::ApiError => e
puts "Exception when calling AlertsApi->disable_alert_rule_using_put: #{e}"
end
```
### Parameters
@@ -152,50 +148,49 @@
| ----------------------- | ----------- | ----------------- | ----- |
| **updateable_alert_id** | **Integer** | updateableAlertId |
### Return type
-[**GenericApiResponse**](GenericApiResponse.md)
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
# **enable_alert_rule_using_put**
-> GenericApiResponse enable_alert_rule_using_put(updateable_alert_id)
+> GenericMapBasedApiResponse enable_alert_rule_using_put(updateable_alert_id)
Enable alert rule
### Example
```ruby
# load the gem
-require 'SematextCloud'
+require 'stcloud'
# setup authorization
-SematextCloud.configure do |config|
+stcloud.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::AlertsApi.new
-
+api_instance = stcloud::AlertsApi.new
updateable_alert_id = 789 # Integer | updateableAlertId
begin
#Enable alert rule
result = api_instance.enable_alert_rule_using_put(updateable_alert_id)
p result
-rescue SematextCloud::ApiError => e
+rescue stcloud::ApiError => e
puts "Exception when calling AlertsApi->enable_alert_rule_using_put: #{e}"
end
```
### Parameters
@@ -204,50 +199,49 @@
| ----------------------- | ----------- | ----------------- | ----- |
| **updateable_alert_id** | **Integer** | updateableAlertId |
### Return type
-[**GenericApiResponse**](GenericApiResponse.md)
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
# **get_alert_rules_for_app_using_get**
-> GenericApiResponse get_alert_rules_for_app_using_get(app_id)
+> AlertRulesResponse get_alert_rules_for_app_using_get(app_id)
Get alert rules for an app
### Example
```ruby
# load the gem
-require 'SematextCloud'
+require 'stcloud'
# setup authorization
-SematextCloud.configure do |config|
+stcloud.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::AlertsApi.new
-
+api_instance = stcloud::AlertsApi.new
app_id = 789 # Integer | appId
begin
#Get alert rules for an app
result = api_instance.get_alert_rules_for_app_using_get(app_id)
p result
-rescue SematextCloud::ApiError => e
+rescue stcloud::ApiError => e
puts "Exception when calling AlertsApi->get_alert_rules_for_app_using_get: #{e}"
end
```
### Parameters
@@ -256,15 +250,15 @@
| ---------- | ----------- | ----------- | ----- |
| **app_id** | **Integer** | appId |
### Return type
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AlertRulesResponse**](AlertRulesResponse.md)
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json