SematextCloud 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +13 -0
- data/README.md +149 -0
- data/Rakefile +8 -0
- data/SematextCloud.gemspec +45 -0
- data/docs/AlertNotificationRequest.md +9 -0
- data/docs/AlertNotificationsApi.md +118 -0
- data/docs/AlertRule.md +53 -0
- data/docs/AlertRuleScheduleTimeRangeDto.md +7 -0
- data/docs/AlertRuleScheduleWeekdayDto.md +10 -0
- data/docs/AlertsApi.md +270 -0
- data/docs/App.md +32 -0
- data/docs/AppDescription.md +6 -0
- data/docs/AppMetadata.md +10 -0
- data/docs/AppsApi.md +369 -0
- data/docs/AwsSettingsControllerApi.md +63 -0
- data/docs/BasicAuthMethodDto.md +7 -0
- data/docs/BasicOrganizationDto.md +9 -0
- data/docs/BillingApi.md +176 -0
- data/docs/BillingInfo.md +8 -0
- data/docs/CloudWatchSettings.md +9 -0
- data/docs/CreateAppInfo.md +10 -0
- data/docs/DataSeriesFilter.md +8 -0
- data/docs/DataSeriesRequest.md +12 -0
- data/docs/Error.md +7 -0
- data/docs/FilterValue.md +11 -0
- data/docs/GenericApiResponse.md +9 -0
- data/docs/Invitation.md +15 -0
- data/docs/LogsAppApi.md +58 -0
- data/docs/MetricsApi.md +227 -0
- data/docs/MonitoringAppApi.md +58 -0
- data/docs/NotificationIntegration.md +15 -0
- data/docs/Plan.md +18 -0
- data/docs/ReportInfo.md +13 -0
- data/docs/ResetPasswordApi.md +58 -0
- data/docs/SavedQueriesApi.md +220 -0
- data/docs/SavedQuery.md +18 -0
- data/docs/ServiceIntegration.md +17 -0
- data/docs/SubscriptionsApi.md +114 -0
- data/docs/TagApiControllerApi.md +212 -0
- data/docs/UpdateAppInfo.md +14 -0
- data/docs/UserInfo.md +6 -0
- data/docs/UserPermissions.md +8 -0
- data/docs/UserRole.md +8 -0
- data/lib/SematextCloud.rb +78 -0
- data/lib/SematextCloud/api/alert_notifications_api.rb +137 -0
- data/lib/SematextCloud/api/alerts_api.rb +283 -0
- data/lib/SematextCloud/api/apps_api.rb +381 -0
- data/lib/SematextCloud/api/aws_settings_controller_api.rb +83 -0
- data/lib/SematextCloud/api/billing_api.rb +197 -0
- data/lib/SematextCloud/api/logs_app_api.rb +75 -0
- data/lib/SematextCloud/api/metrics_api.rb +247 -0
- data/lib/SematextCloud/api/monitoring_app_api.rb +75 -0
- data/lib/SematextCloud/api/reset_password_api.rb +75 -0
- data/lib/SematextCloud/api/saved_queries_api.rb +237 -0
- data/lib/SematextCloud/api/subscriptions_api.rb +133 -0
- data/lib/SematextCloud/api/tag_api_controller_api.rb +247 -0
- data/lib/SematextCloud/api_client.rb +389 -0
- data/lib/SematextCloud/api_error.rb +38 -0
- data/lib/SematextCloud/configuration.rb +209 -0
- data/lib/SematextCloud/models/alert_notification_request.rb +212 -0
- data/lib/SematextCloud/models/alert_rule.rb +652 -0
- data/lib/SematextCloud/models/alert_rule_schedule_time_range_dto.rb +192 -0
- data/lib/SematextCloud/models/alert_rule_schedule_weekday_dto.rb +221 -0
- data/lib/SematextCloud/models/app.rb +419 -0
- data/lib/SematextCloud/models/app_description.rb +183 -0
- data/lib/SematextCloud/models/app_metadata.rb +268 -0
- data/lib/SematextCloud/models/basic_auth_method_dto.rb +226 -0
- data/lib/SematextCloud/models/basic_organization_dto.rb +246 -0
- data/lib/SematextCloud/models/billing_info.rb +201 -0
- data/lib/SematextCloud/models/cloud_watch_settings.rb +256 -0
- data/lib/SematextCloud/models/create_app_info.rb +220 -0
- data/lib/SematextCloud/models/data_series_filter.rb +237 -0
- data/lib/SematextCloud/models/data_series_request.rb +283 -0
- data/lib/SematextCloud/models/error.rb +192 -0
- data/lib/SematextCloud/models/filter_value.rb +230 -0
- data/lib/SematextCloud/models/generic_api_response.rb +214 -0
- data/lib/SematextCloud/models/invitation.rb +326 -0
- data/lib/SematextCloud/models/notification_integration.rb +324 -0
- data/lib/SematextCloud/models/plan.rb +337 -0
- data/lib/SematextCloud/models/report_info.rb +247 -0
- data/lib/SematextCloud/models/saved_query.rb +291 -0
- data/lib/SematextCloud/models/service_integration.rb +282 -0
- data/lib/SematextCloud/models/update_app_info.rb +289 -0
- data/lib/SematextCloud/models/user_info.rb +183 -0
- data/lib/SematextCloud/models/user_permissions.rb +201 -0
- data/lib/SematextCloud/models/user_role.rb +247 -0
- data/lib/SematextCloud/version.rb +15 -0
- data/spec/api/alert_notifications_api_spec.rb +60 -0
- data/spec/api/alerts_api_spec.rb +90 -0
- data/spec/api/apps_api_spec.rb +113 -0
- data/spec/api/aws_settings_controller_api_spec.rb +48 -0
- data/spec/api/billing_api_spec.rb +72 -0
- data/spec/api/logs_app_api_spec.rb +46 -0
- data/spec/api/metrics_api_spec.rb +83 -0
- data/spec/api/monitoring_app_api_spec.rb +46 -0
- data/spec/api/reset_password_api_spec.rb +46 -0
- data/spec/api/saved_queries_api_spec.rb +80 -0
- data/spec/api/subscriptions_api_spec.rb +58 -0
- data/spec/api/tag_api_controller_api_spec.rb +88 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/alert_notification_request_spec.rb +59 -0
- data/spec/models/alert_rule_schedule_time_range_dto_spec.rb +47 -0
- data/spec/models/alert_rule_schedule_weekday_dto_spec.rb +65 -0
- data/spec/models/alert_rule_spec.rb +327 -0
- data/spec/models/app_description_spec.rb +41 -0
- data/spec/models/app_metadata_spec.rb +77 -0
- data/spec/models/app_spec.rb +197 -0
- data/spec/models/basic_auth_method_dto_spec.rb +51 -0
- data/spec/models/basic_organization_dto_spec.rb +63 -0
- data/spec/models/billing_info_spec.rb +53 -0
- data/spec/models/cloud_watch_settings_spec.rb +67 -0
- data/spec/models/create_app_info_spec.rb +65 -0
- data/spec/models/data_series_filter_spec.rb +57 -0
- data/spec/models/data_series_request_spec.rb +81 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/filter_value_spec.rb +71 -0
- data/spec/models/generic_api_response_spec.rb +59 -0
- data/spec/models/invitation_spec.rb +107 -0
- data/spec/models/notification_integration_spec.rb +107 -0
- data/spec/models/plan_spec.rb +121 -0
- data/spec/models/report_info_spec.rb +83 -0
- data/spec/models/saved_query_spec.rb +113 -0
- data/spec/models/service_integration_spec.rb +107 -0
- data/spec/models/update_app_info_spec.rb +93 -0
- data/spec/models/user_info_spec.rb +41 -0
- data/spec/models/user_permissions_spec.rb +53 -0
- data/spec/models/user_role_spec.rb +61 -0
- data/spec/spec_helper.rb +111 -0
- metadata +395 -0
@@ -0,0 +1,58 @@
|
|
1
|
+
# SematextCloud::MonitoringAppApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_spm_application1**](MonitoringAppApi.md#create_spm_application1) | **POST** /spm-reports/api/v3/apps | Create Monitoring App
|
8
|
+
|
9
|
+
|
10
|
+
# **create_spm_application1**
|
11
|
+
> GenericApiResponse create_spm_application1(application_details)
|
12
|
+
|
13
|
+
Create Monitoring App
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'SematextCloud'
|
19
|
+
# setup authorization
|
20
|
+
SematextCloud.configure do |config|
|
21
|
+
# Configure API key authorization: api_key
|
22
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
23
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
24
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = SematextCloud::MonitoringAppApi.new
|
28
|
+
|
29
|
+
application_details = SematextCloud::CreateAppInfo.new # CreateAppInfo | Details of the application to be created
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Create Monitoring App
|
34
|
+
result = api_instance.create_spm_application1(application_details)
|
35
|
+
p result
|
36
|
+
rescue SematextCloud::ApiError => e
|
37
|
+
puts "Exception when calling MonitoringAppApi->create_spm_application1: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**application_details** | [**CreateAppInfo**](CreateAppInfo.md)| Details of the application to be created |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
[api_key](../README.md#api_key)
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json
|
58
|
+
- **Accept**: application/json
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# SematextCloud::NotificationIntegration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**applicability** | **String** | | [optional]
|
7
|
+
**create_date** | **DateTime** | | [optional]
|
8
|
+
**created_by_owner** | **BOOLEAN** | | [optional]
|
9
|
+
**creator_id** | **Integer** | | [optional]
|
10
|
+
**id** | **Integer** | | [optional]
|
11
|
+
**integration_type** | **String** | | [optional]
|
12
|
+
**name** | **String** | | [optional]
|
13
|
+
**params** | **Hash<String, String>** | | [optional]
|
14
|
+
**state** | **String** | | [optional]
|
15
|
+
**user_id** | **Integer** | | [optional]
|
data/docs/Plan.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# SematextCloud::Plan
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**app_type** | **String** | | [optional]
|
7
|
+
**custom** | **BOOLEAN** | | [optional]
|
8
|
+
**data_retention_hours** | **Float** | | [optional]
|
9
|
+
**default_trial_plan** | **BOOLEAN** | | [optional]
|
10
|
+
**free** | **BOOLEAN** | | [optional]
|
11
|
+
**free_trial_days** | **Integer** | | [optional]
|
12
|
+
**id** | **Integer** | | [optional]
|
13
|
+
**max_alerts** | **Integer** | | [optional]
|
14
|
+
**max_daily_events** | **Integer** | | [optional]
|
15
|
+
**name** | **String** | | [optional]
|
16
|
+
**plan_scheme** | **String** | | [optional]
|
17
|
+
**sematext_service** | **String** | | [optional]
|
18
|
+
**trial_plan** | **BOOLEAN** | | [optional]
|
data/docs/ReportInfo.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SematextCloud::ReportInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**addresses** | **String** | Comma separated list of email addresses | [optional]
|
7
|
+
**app_id** | **Integer** | | [optional]
|
8
|
+
**end_date** | **DateTime** | | [optional]
|
9
|
+
**filters** | **String** | | [optional]
|
10
|
+
**report_name** | **String** | | [optional]
|
11
|
+
**start_date** | **DateTime** | | [optional]
|
12
|
+
**subject** | **String** | | [optional]
|
13
|
+
**text** | **String** | | [optional]
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# SematextCloud::ResetPasswordApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**reset_password_using_post**](ResetPasswordApi.md#reset_password_using_post) | **POST** /users-web/api/v3/account/password/reset | Reset Password
|
8
|
+
|
9
|
+
|
10
|
+
# **reset_password_using_post**
|
11
|
+
> GenericApiResponse reset_password_using_post(dto)
|
12
|
+
|
13
|
+
Reset Password
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'SematextCloud'
|
19
|
+
# setup authorization
|
20
|
+
SematextCloud.configure do |config|
|
21
|
+
# Configure API key authorization: api_key
|
22
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
23
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
24
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
25
|
+
end
|
26
|
+
|
27
|
+
api_instance = SematextCloud::ResetPasswordApi.new
|
28
|
+
|
29
|
+
dto = SematextCloud::UserInfo.new # UserInfo | dto
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Reset Password
|
34
|
+
result = api_instance.reset_password_using_post(dto)
|
35
|
+
p result
|
36
|
+
rescue SematextCloud::ApiError => e
|
37
|
+
puts "Exception when calling ResetPasswordApi->reset_password_using_post: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**dto** | [**UserInfo**](UserInfo.md)| dto |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
[api_key](../README.md#api_key)
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json
|
58
|
+
- **Accept**: application/json
|
@@ -0,0 +1,220 @@
|
|
1
|
+
# SematextCloud::SavedQueriesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_saved_query_using_delete**](SavedQueriesApi.md#delete_saved_query_using_delete) | **DELETE** /users-web/api/v3/savedQueries/{updateableQueryId} | Delete saved query
|
8
|
+
[**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
|
9
|
+
[**save_query_using_post**](SavedQueriesApi.md#save_query_using_post) | **POST** /users-web/api/v3/savedQueries | Create saved query
|
10
|
+
[**save_query_using_put**](SavedQueriesApi.md#save_query_using_put) | **PUT** /users-web/api/v3/savedQueries/{updateableQueryId} | Update saved query
|
11
|
+
|
12
|
+
|
13
|
+
# **delete_saved_query_using_delete**
|
14
|
+
> GenericApiResponse delete_saved_query_using_delete(updateable_query_id)
|
15
|
+
|
16
|
+
Delete saved query
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'SematextCloud'
|
22
|
+
# setup authorization
|
23
|
+
SematextCloud.configure do |config|
|
24
|
+
# Configure API key authorization: api_key
|
25
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = SematextCloud::SavedQueriesApi.new
|
31
|
+
|
32
|
+
updateable_query_id = 789 # Integer | updateableQueryId
|
33
|
+
|
34
|
+
|
35
|
+
begin
|
36
|
+
#Delete saved query
|
37
|
+
result = api_instance.delete_saved_query_using_delete(updateable_query_id)
|
38
|
+
p result
|
39
|
+
rescue SematextCloud::ApiError => e
|
40
|
+
puts "Exception when calling SavedQueriesApi->delete_saved_query_using_delete: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
### Parameters
|
45
|
+
|
46
|
+
Name | Type | Description | Notes
|
47
|
+
------------- | ------------- | ------------- | -------------
|
48
|
+
**updateable_query_id** | **Integer**| updateableQueryId |
|
49
|
+
|
50
|
+
### Return type
|
51
|
+
|
52
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
[api_key](../README.md#api_key)
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: application/json
|
61
|
+
- **Accept**: application/json
|
62
|
+
|
63
|
+
|
64
|
+
|
65
|
+
# **get_saved_queries_for_app_using_get**
|
66
|
+
> GenericApiResponse get_saved_queries_for_app_using_get(app_id)
|
67
|
+
|
68
|
+
Get saved queries for an app
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'SematextCloud'
|
74
|
+
# setup authorization
|
75
|
+
SematextCloud.configure do |config|
|
76
|
+
# Configure API key authorization: api_key
|
77
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
78
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
79
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
80
|
+
end
|
81
|
+
|
82
|
+
api_instance = SematextCloud::SavedQueriesApi.new
|
83
|
+
|
84
|
+
app_id = 789 # Integer | appId
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
#Get saved queries for an app
|
89
|
+
result = api_instance.get_saved_queries_for_app_using_get(app_id)
|
90
|
+
p result
|
91
|
+
rescue SematextCloud::ApiError => e
|
92
|
+
puts "Exception when calling SavedQueriesApi->get_saved_queries_for_app_using_get: #{e}"
|
93
|
+
end
|
94
|
+
```
|
95
|
+
|
96
|
+
### Parameters
|
97
|
+
|
98
|
+
Name | Type | Description | Notes
|
99
|
+
------------- | ------------- | ------------- | -------------
|
100
|
+
**app_id** | **Integer**| appId |
|
101
|
+
|
102
|
+
### Return type
|
103
|
+
|
104
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
105
|
+
|
106
|
+
### Authorization
|
107
|
+
|
108
|
+
[api_key](../README.md#api_key)
|
109
|
+
|
110
|
+
### HTTP request headers
|
111
|
+
|
112
|
+
- **Content-Type**: application/json
|
113
|
+
- **Accept**: application/json
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
# **save_query_using_post**
|
118
|
+
> GenericApiResponse save_query_using_post(saved_query_dto)
|
119
|
+
|
120
|
+
Create saved query
|
121
|
+
|
122
|
+
### Example
|
123
|
+
```ruby
|
124
|
+
# load the gem
|
125
|
+
require 'SematextCloud'
|
126
|
+
# setup authorization
|
127
|
+
SematextCloud.configure do |config|
|
128
|
+
# Configure API key authorization: api_key
|
129
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
131
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
132
|
+
end
|
133
|
+
|
134
|
+
api_instance = SematextCloud::SavedQueriesApi.new
|
135
|
+
|
136
|
+
saved_query_dto = SematextCloud::SavedQuery.new # SavedQuery | savedQueryDto
|
137
|
+
|
138
|
+
|
139
|
+
begin
|
140
|
+
#Create saved query
|
141
|
+
result = api_instance.save_query_using_post(saved_query_dto)
|
142
|
+
p result
|
143
|
+
rescue SematextCloud::ApiError => e
|
144
|
+
puts "Exception when calling SavedQueriesApi->save_query_using_post: #{e}"
|
145
|
+
end
|
146
|
+
```
|
147
|
+
|
148
|
+
### Parameters
|
149
|
+
|
150
|
+
Name | Type | Description | Notes
|
151
|
+
------------- | ------------- | ------------- | -------------
|
152
|
+
**saved_query_dto** | [**SavedQuery**](SavedQuery.md)| savedQueryDto |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[api_key](../README.md#api_key)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: application/json
|
165
|
+
- **Accept**: application/json
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
# **save_query_using_put**
|
170
|
+
> GenericApiResponse save_query_using_put(saved_query_dto, updateable_query_id)
|
171
|
+
|
172
|
+
Update saved query
|
173
|
+
|
174
|
+
### Example
|
175
|
+
```ruby
|
176
|
+
# load the gem
|
177
|
+
require 'SematextCloud'
|
178
|
+
# setup authorization
|
179
|
+
SematextCloud.configure do |config|
|
180
|
+
# Configure API key authorization: api_key
|
181
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
182
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
183
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
184
|
+
end
|
185
|
+
|
186
|
+
api_instance = SematextCloud::SavedQueriesApi.new
|
187
|
+
|
188
|
+
saved_query_dto = SematextCloud::SavedQuery.new # SavedQuery | savedQueryDto
|
189
|
+
|
190
|
+
updateable_query_id = 789 # Integer | updateableQueryId
|
191
|
+
|
192
|
+
|
193
|
+
begin
|
194
|
+
#Update saved query
|
195
|
+
result = api_instance.save_query_using_put(saved_query_dto, updateable_query_id)
|
196
|
+
p result
|
197
|
+
rescue SematextCloud::ApiError => e
|
198
|
+
puts "Exception when calling SavedQueriesApi->save_query_using_put: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
Name | Type | Description | Notes
|
205
|
+
------------- | ------------- | ------------- | -------------
|
206
|
+
**saved_query_dto** | [**SavedQuery**](SavedQuery.md)| savedQueryDto |
|
207
|
+
**updateable_query_id** | **Integer**| updateableQueryId |
|
208
|
+
|
209
|
+
### Return type
|
210
|
+
|
211
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
212
|
+
|
213
|
+
### Authorization
|
214
|
+
|
215
|
+
[api_key](../README.md#api_key)
|
216
|
+
|
217
|
+
### HTTP request headers
|
218
|
+
|
219
|
+
- **Content-Type**: application/json
|
220
|
+
- **Accept**: application/json
|
data/docs/SavedQuery.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# SematextCloud::SavedQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**alert_rule** | [**AlertRule**](AlertRule.md) | | [optional]
|
7
|
+
**allow_modification** | **BOOLEAN** | | [optional]
|
8
|
+
**application_id** | **String** | | [optional]
|
9
|
+
**application_name** | **String** | | [optional]
|
10
|
+
**application_token** | **String** | | [optional]
|
11
|
+
**creator_email** | **String** | | [optional]
|
12
|
+
**id** | **String** | | [optional]
|
13
|
+
**label_color** | **String** | | [optional]
|
14
|
+
**logsene_alert_type** | **Object** | | [optional]
|
15
|
+
**owner_email** | **String** | | [optional]
|
16
|
+
**query_name** | **String** | | [optional]
|
17
|
+
**query_string** | **String** | | [optional]
|
18
|
+
**user_permissions** | [**UserPermissions**](UserPermissions.md) | | [optional]
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SematextCloud::ServiceIntegration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**app_type_id** | **Integer** | | [optional]
|
7
|
+
**app_type_name** | **String** | | [optional]
|
8
|
+
**display_name** | **String** | | [optional]
|
9
|
+
**enabled** | **BOOLEAN** | | [optional]
|
10
|
+
**external_product_id** | **Integer** | | [optional]
|
11
|
+
**external_product_name** | **String** | | [optional]
|
12
|
+
**id** | **Integer** | | [optional]
|
13
|
+
**integration_type** | **String** | | [optional]
|
14
|
+
**ordinal** | **Integer** | | [optional]
|
15
|
+
**parent_integration_id** | **Integer** | | [optional]
|
16
|
+
**sematext_service** | **String** | | [optional]
|
17
|
+
**visible** | **BOOLEAN** | | [optional]
|
@@ -0,0 +1,114 @@
|
|
1
|
+
# SematextCloud::SubscriptionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_using_get1**](SubscriptionsApi.md#list_using_get1) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an app
|
8
|
+
[**send_report_using_post**](SubscriptionsApi.md#send_report_using_post) | **POST** /users-web/api/v3/apps/{appId}/report/send | Trigger emailing of report for an app
|
9
|
+
|
10
|
+
|
11
|
+
# **list_using_get1**
|
12
|
+
> GenericApiResponse list_using_get1(app_id)
|
13
|
+
|
14
|
+
Get subscriptions for an app
|
15
|
+
|
16
|
+
### Example
|
17
|
+
```ruby
|
18
|
+
# load the gem
|
19
|
+
require 'SematextCloud'
|
20
|
+
# setup authorization
|
21
|
+
SematextCloud.configure do |config|
|
22
|
+
# Configure API key authorization: api_key
|
23
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
24
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
25
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = SematextCloud::SubscriptionsApi.new
|
29
|
+
|
30
|
+
app_id = 789 # Integer | appId
|
31
|
+
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Get subscriptions for an app
|
35
|
+
result = api_instance.list_using_get1(app_id)
|
36
|
+
p result
|
37
|
+
rescue SematextCloud::ApiError => e
|
38
|
+
puts "Exception when calling SubscriptionsApi->list_using_get1: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**app_id** | **Integer**| appId |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
[api_key](../README.md#api_key)
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/json
|
59
|
+
- **Accept**: application/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **send_report_using_post**
|
64
|
+
> GenericApiResponse send_report_using_post(app_id, email_dto)
|
65
|
+
|
66
|
+
Trigger emailing of report for an app
|
67
|
+
|
68
|
+
### Example
|
69
|
+
```ruby
|
70
|
+
# load the gem
|
71
|
+
require 'SematextCloud'
|
72
|
+
# setup authorization
|
73
|
+
SematextCloud.configure do |config|
|
74
|
+
# Configure API key authorization: api_key
|
75
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
76
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
77
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
78
|
+
end
|
79
|
+
|
80
|
+
api_instance = SematextCloud::SubscriptionsApi.new
|
81
|
+
|
82
|
+
app_id = 789 # Integer | appId
|
83
|
+
|
84
|
+
email_dto = SematextCloud::ReportInfo.new # ReportInfo | emailDto
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
#Trigger emailing of report for an app
|
89
|
+
result = api_instance.send_report_using_post(app_id, email_dto)
|
90
|
+
p result
|
91
|
+
rescue SematextCloud::ApiError => e
|
92
|
+
puts "Exception when calling SubscriptionsApi->send_report_using_post: #{e}"
|
93
|
+
end
|
94
|
+
```
|
95
|
+
|
96
|
+
### Parameters
|
97
|
+
|
98
|
+
Name | Type | Description | Notes
|
99
|
+
------------- | ------------- | ------------- | -------------
|
100
|
+
**app_id** | **Integer**| appId |
|
101
|
+
**email_dto** | [**ReportInfo**](ReportInfo.md)| emailDto |
|
102
|
+
|
103
|
+
### Return type
|
104
|
+
|
105
|
+
[**GenericApiResponse**](GenericApiResponse.md)
|
106
|
+
|
107
|
+
### Authorization
|
108
|
+
|
109
|
+
[api_key](../README.md#api_key)
|
110
|
+
|
111
|
+
### HTTP request headers
|
112
|
+
|
113
|
+
- **Content-Type**: application/json
|
114
|
+
- **Accept**: application/json
|