SematextCloud 0.1.1 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +91 -69
- data/docs/AlertNotificationRequest.md +6 -6
- data/docs/AlertNotificationsApi.md +11 -11
- data/docs/AlertRule.md +50 -50
- data/docs/AlertRuleScheduleTimeRangeDto.md +4 -4
- data/docs/AlertRuleScheduleWeekdayDto.md +7 -7
- data/docs/AlertsApi.md +22 -22
- data/docs/App.md +33 -29
- data/docs/AppDescription.md +3 -3
- data/docs/AppMetadata.md +7 -7
- data/docs/AppsApi.md +23 -23
- data/docs/AwsSettingsControllerApi.md +7 -7
- data/docs/BasicAuthMethodDto.md +4 -4
- data/docs/BasicOrganizationDto.md +6 -6
- data/docs/BillingApi.md +18 -18
- data/docs/BillingInfo.md +5 -5
- data/docs/CloudWatchSettings.md +6 -6
- data/docs/CreateAppInfo.md +7 -7
- data/docs/CreateTokenDto.md +7 -0
- data/docs/DataSeriesFilter.md +5 -5
- data/docs/DataSeriesRequest.md +9 -9
- data/docs/Error.md +4 -4
- data/docs/FilterValue.md +8 -8
- data/docs/GenericApiResponse.md +6 -6
- data/docs/Invitation.md +12 -12
- data/docs/LogsAppApi.md +6 -6
- data/docs/MetricsApi.md +20 -20
- data/docs/MonitoringAppApi.md +6 -6
- data/docs/NotificationIntegration.md +12 -12
- data/docs/Plan.md +15 -15
- data/docs/ReportInfo.md +10 -10
- data/docs/ResetPasswordApi.md +6 -6
- data/docs/SavedQueriesApi.md +19 -19
- data/docs/SavedQuery.md +15 -15
- data/docs/ServiceIntegration.md +14 -14
- data/docs/SubscriptionDashboardDto.md +16 -0
- data/docs/SubscriptionDto.md +17 -0
- data/docs/SubscriptionsApi.md +468 -32
- data/docs/TagApiControllerApi.md +34 -34
- data/docs/TokensApiControllerApi.md +285 -0
- data/docs/UpdateAppInfo.md +11 -11
- data/docs/UpdateSubscriptionDto.md +6 -0
- data/docs/UpdateTokenDto.md +6 -0
- data/docs/UserInfo.md +3 -3
- data/docs/UserPermissions.md +5 -5
- data/docs/UserRole.md +5 -5
- data/lib/SematextCloud/api/apps_api.rb +52 -0
- data/lib/SematextCloud/api/subscriptions_api.rb +463 -17
- data/lib/SematextCloud/api/tokens_api_controller_api.rb +313 -0
- data/lib/SematextCloud/models/create_token_dto.rb +192 -0
- data/lib/SematextCloud/models/subscription_dashboard_dto.rb +319 -0
- data/lib/SematextCloud/models/subscription_dto.rb +328 -0
- data/lib/SematextCloud/models/update_subscription_dto.rb +183 -0
- data/lib/SematextCloud/models/update_token_dto.rb +183 -0
- data/lib/SematextCloud/version.rb +1 -1
- data/spec/api/tokens_api_controller_api_spec.rb +95 -0
- data/spec/models/create_token_dto_spec.rb +47 -0
- data/spec/models/subscription_dashboard_dto_spec.rb +109 -0
- data/spec/models/subscription_dto_spec.rb +115 -0
- data/spec/models/update_subscription_dto_spec.rb +41 -0
- data/spec/models/update_token_dto_spec.rb +41 -0
- metadata +55 -32
- data/assets/octi-blue.png +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 49a826d17e7dd9e2ec88f122819f742fe82fe39cacb9af1ec534d190151be1c9
|
|
4
|
+
data.tar.gz: 0b249455b7b3bbe56034869e29e45a1b865bcf5e47ccb18c9025aa6d4af5422a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 48eac8f1f318af60841cd5315c746844973bf260d425ff1886a09bae6ddc81808e751021a4cf4c37606c879e5446d56fc7d237c2abcb88d883afa51f2efb9ddd
|
|
7
|
+
data.tar.gz: 8edb5bf621a028ee0bbc2d942f4c5e635ab54f4fe705a3e4bb6b5ef7aaa33e93b5e1c415518cda55ca9fcbec5bd0ea6aebe737169bfcd1a0b3c03882a632ce48
|
data/Gemfile
CHANGED
data/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
# <img src="
|
|
2
|
+
# <img src="https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png" valign="bottom" width="60px"/>** sematext-api-client-ruby**
|
|
3
3
|
|
|
4
4
|
<br>
|
|
5
5
|
|
|
@@ -33,11 +33,14 @@ Refer to below link for deeper information on the API itself.
|
|
|
33
33
|
|
|
34
34
|
## Contents
|
|
35
35
|
|
|
36
|
-
- [
|
|
36
|
+
- [<img src="https://sematext.com/wp-content/uploads/2020/09/just-octi-blue.png" valign="bottom" width="60px"/>** sematext-api-client-ruby**](#img-srchttpssematextcomwp-contentuploads202009just-octi-bluepng-valignbottom-width60pxsematext-api-client-ruby)
|
|
37
37
|
- [Contents](#contents)
|
|
38
38
|
- [Installation](#installation)
|
|
39
|
-
|
|
39
|
+
- [Build a gem](#build-a-gem)
|
|
40
|
+
- [Install from Git](#install-from-git)
|
|
41
|
+
- [Include the Ruby code directly](#include-the-ruby-code-directly)
|
|
40
42
|
- [Authentication](#authentication)
|
|
43
|
+
- [Getting Started](#getting-started)
|
|
41
44
|
- [Reference](#reference)
|
|
42
45
|
- [Documentation for Models](#documentation-for-models)
|
|
43
46
|
|
|
@@ -56,15 +59,15 @@ gem build SematextCloud.gemspec
|
|
|
56
59
|
Then either install the gem locally:
|
|
57
60
|
|
|
58
61
|
```shell
|
|
59
|
-
gem install ./SematextCloud-0.1.
|
|
62
|
+
gem install ./SematextCloud-0.1.3.gem
|
|
60
63
|
```
|
|
61
|
-
(for development, run `gem install --dev ./SematextCloud-0.1.
|
|
64
|
+
(for development, run `gem install --dev ./SematextCloud-0.1.3.gem` to install the development dependencies)
|
|
62
65
|
|
|
63
66
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
64
67
|
|
|
65
68
|
Finally add this to the Gemfile:
|
|
66
69
|
|
|
67
|
-
gem 'SematextCloud', '~> 0.1.
|
|
70
|
+
gem 'SematextCloud', '~> 0.1.3'
|
|
68
71
|
|
|
69
72
|
### Install from Git
|
|
70
73
|
|
|
@@ -121,70 +124,89 @@ end
|
|
|
121
124
|
|
|
122
125
|
All URIs are relative to *https://localhost*
|
|
123
126
|
|
|
124
|
-
Class
|
|
125
|
-
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
127
|
+
| Class | Method | HTTP request | Description |
|
|
128
|
+
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
|
129
|
+
| *stcloud::AlertNotificationsApi* | [**get_alert_notifications_for_app_using_post1**](docs/AlertNotificationsApi.md#get_alert_notifications_for_app_using_post1) | **POST** /users-web/api/v3/apps/{appId}/notifications/alerts | Get alert notifications for an app |
|
|
130
|
+
| *stcloud::AlertNotificationsApi* | [**get_alert_notifications_for_user_using_post**](docs/AlertNotificationsApi.md#get_alert_notifications_for_user_using_post) | **POST** /users-web/api/v3/notifications/alerts | Get alert notifications for a user |
|
|
131
|
+
| *stcloud::AlertsApi* | [**create_alert_using_post1**](docs/AlertsApi.md#create_alert_using_post1) | **POST** /users-web/api/v3/alerts | Create alert rule |
|
|
132
|
+
| *stcloud::AlertsApi* | [**delete_alert_rule_using_delete1**](docs/AlertsApi.md#delete_alert_rule_using_delete1) | **DELETE** /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule |
|
|
133
|
+
| *stcloud::AlertsApi* | [**disable_alert_rule_using_put**](docs/AlertsApi.md#disable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule |
|
|
134
|
+
| *stcloud::AlertsApi* | [**enable_alert_rule_using_put1**](docs/AlertsApi.md#enable_alert_rule_using_put1) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule |
|
|
135
|
+
| *stcloud::AlertsApi* | [**get_alert_rules_for_app_using_get1**](docs/AlertsApi.md#get_alert_rules_for_app_using_get1) | **GET** /users-web/api/v3/apps/{appId}/alerts | Get alert rules for an app |
|
|
136
|
+
| *stcloud::AppsApi* | [**delete_using_delete**](docs/AppsApi.md#delete_using_delete) | **DELETE** /users-web/api/v3/apps/{anyStateAppId} | delete |
|
|
137
|
+
| *stcloud::AppsApi* | [**get_app_types_using_get1**](docs/AppsApi.md#get_app_types_using_get1) | **GET** /users-web/api/v3/apps/types | Get all App types supported for the account identified with apiKey |
|
|
138
|
+
| *stcloud::AppsApi* | [**get_using_get**](docs/AppsApi.md#get_using_get) | **GET** /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App |
|
|
139
|
+
| *stcloud::AppsApi* | [**invite_app_guests_using_post**](docs/AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests | Invite guests to an app |
|
|
140
|
+
| *stcloud::AppsApi* | [**list_apps_users_using_get**](docs/AppsApi.md#list_apps_users_using_get) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account |
|
|
141
|
+
| *stcloud::AppsApi* | [**list_using_get1**](docs/AppsApi.md#list_using_get1) | **GET** /users-web/api/v3/apps | Get all apps accessible by account identified with apiKey |
|
|
142
|
+
| *stcloud::AppsApi* | [**update_description_using_put**](docs/AppsApi.md#update_description_using_put) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app |
|
|
143
|
+
| *stcloud::AppsApi* | [**update_using_put3**](docs/AppsApi.md#update_using_put3) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app |
|
|
144
|
+
| *stcloud::AwsSettingsControllerApi* | [**update_using_put**](docs/AwsSettingsControllerApi.md#update_using_put) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings |
|
|
145
|
+
| *stcloud::BillingApi* | [**get_detailed_invoice_using_get1**](docs/BillingApi.md#get_detailed_invoice_using_get1) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details |
|
|
146
|
+
| *stcloud::BillingApi* | [**list_available_plans_using_get1**](docs/BillingApi.md#list_available_plans_using_get1) | **GET** /users-web/api/v3/billing/availablePlans | Get available plans |
|
|
147
|
+
| *stcloud::BillingApi* | [**update_plan_using_put**](docs/BillingApi.md#update_plan_using_put) | **PUT** /users-web/api/v3/billing/info/{appId} | Update plan for an app |
|
|
148
|
+
| *stcloud::LogsAppApi* | [**create_logsene_application**](docs/LogsAppApi.md#create_logsene_application) | **POST** /logsene-reports/api/v3/apps | Create Logs App |
|
|
149
|
+
| *stcloud::MetricsApi* | [**list_data_series_using_post1**](docs/MetricsApi.md#list_data_series_using_post1) | **POST** /spm-reports/api/v3/apps/{appId}/metrics/data | Get metrics data points for an app |
|
|
150
|
+
| *stcloud::MetricsApi* | [**list_filters_using_post1**](docs/MetricsApi.md#list_filters_using_post1) | **POST** /spm-reports/api/v3/apps/{appId}/metrics/filters | Get metrics filters and their values for an app |
|
|
151
|
+
| *stcloud::MetricsApi* | [**list_metrics_keys_using_get1**](docs/MetricsApi.md#list_metrics_keys_using_get1) | **GET** /spm-reports/api/v3/apps/{appId}/metrics/keys | Get metrics keys for an app |
|
|
152
|
+
| *stcloud::MetricsApi* | [**list_metrics_using_get**](docs/MetricsApi.md#list_metrics_using_get) | **GET** /spm-reports/api/v3/apps/{appId}/metrics | Get metrics info for an app |
|
|
153
|
+
| *stcloud::MonitoringAppApi* | [**create_spm_application**](docs/MonitoringAppApi.md#create_spm_application) | **POST** /spm-reports/api/v3/apps | Create Monitoring App |
|
|
154
|
+
| *stcloud::ResetPasswordApi* | [**reset_password_using_post1**](docs/ResetPasswordApi.md#reset_password_using_post1) | **POST** /users-web/api/v3/account/password/reset | Reset Password |
|
|
155
|
+
| *stcloud::SavedQueriesApi* | [**delete_saved_query_using_delete**](docs/SavedQueriesApi.md#delete_saved_query_using_delete) | **DELETE** /users-web/api/v3/savedQueries/{updateableQueryId} | Delete saved query |
|
|
156
|
+
| *stcloud::SavedQueriesApi* | [**get_saved_queries_for_app_using_get**](docs/SavedQueriesApi.md#get_saved_queries_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/savedQueries | Get saved queries for an app |
|
|
157
|
+
| *stcloud::SavedQueriesApi* | [**save_query_using_post**](docs/SavedQueriesApi.md#save_query_using_post) | **POST** /users-web/api/v3/savedQueries | Create saved query |
|
|
158
|
+
| *stcloud::SavedQueriesApi* | [**save_query_using_put**](docs/SavedQueriesApi.md#save_query_using_put) | **PUT** /users-web/api/v3/savedQueries/{updateableQueryId} | Update saved query |
|
|
159
|
+
| *stcloud::SubscriptionsApi* | [**create_for_app_using_post**](docs/SubscriptionsApi.md#create_for_app_using_post) | **POST** /users-web/api/v3/apps/{appId}/subscription | Create App subscription |
|
|
160
|
+
| *stcloud::SubscriptionsApi* | [**create_for_dash_using_post1**](docs/SubscriptionsApi.md#create_for_dash_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/subscription | Create dashboard subscription |
|
|
161
|
+
| *stcloud::SubscriptionsApi* | [**delete_using_delete2**](docs/SubscriptionsApi.md#delete_using_delete2) | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription |
|
|
162
|
+
| *stcloud::SubscriptionsApi* | [**list_using_get2**](docs/SubscriptionsApi.md#list_using_get2) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an App |
|
|
163
|
+
| *stcloud::SubscriptionsApi* | [**list_using_get5**](docs/SubscriptionsApi.md#list_using_get5) | **GET** /users-web/api/v3/subscriptions | Get current account's subscriptions |
|
|
164
|
+
| *stcloud::SubscriptionsApi* | [**send_app_report_using_post1**](docs/SubscriptionsApi.md#send_app_report_using_post1) | **POST** /users-web/api/v3/apps/{appId}/report/send | Email an App report |
|
|
165
|
+
| *stcloud::SubscriptionsApi* | [**send_dash_report_using_post1**](docs/SubscriptionsApi.md#send_dash_report_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/report/send | Email a dashboard report |
|
|
166
|
+
| *stcloud::SubscriptionsApi* | [**toggle_enabled_using_put1**](docs/SubscriptionsApi.md#toggle_enabled_using_put1) | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Toggle subscription status |
|
|
167
|
+
| *stcloud::SubscriptionsApi* | [**update_for_app_using_put1**](docs/SubscriptionsApi.md#update_for_app_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/subscription | Update App subscription |
|
|
168
|
+
| *stcloud::SubscriptionsApi* | [**update_for_dash_using_put**](docs/SubscriptionsApi.md#update_for_dash_using_put) | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription | Update dashboard subscription |
|
|
169
|
+
| *stcloud::TagApiControllerApi* | [**get_tag_names_using_get**](docs/TagApiControllerApi.md#get_tag_names_using_get) | **GET** /spm-reports/api/v3/apps/{appIds}/tagNames | Gets tag names for the given application identifiers appearing in the given time frame. |
|
|
170
|
+
| *stcloud::TagApiControllerApi* | [**get_using_get2**](docs/TagApiControllerApi.md#get_using_get2) | **GET** /spm-reports/api/v3/apps/{appIds}/metrics/filters | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
|
|
171
|
+
| *stcloud::TagApiControllerApi* | [**get_using_get3**](docs/TagApiControllerApi.md#get_using_get3) | **GET** /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
|
|
172
|
+
| *stcloud::TokensApiControllerApi* | [**create_app_token**](docs/TokensApiControllerApi.md#create_app_token) | **POST** /users-web/api/v3/apps/{appId}/tokens | Create new app token |
|
|
173
|
+
| *stcloud::TokensApiControllerApi* | [**delete_app_token1**](docs/TokensApiControllerApi.md#delete_app_token1) | **DELETE** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Delete app token |
|
|
174
|
+
| *stcloud::TokensApiControllerApi* | [**get_app_tokens1**](docs/TokensApiControllerApi.md#get_app_tokens1) | **GET** /users-web/api/v3/apps/{appId}/tokens | Get app available tokens |
|
|
175
|
+
| *stcloud::TokensApiControllerApi* | [**regenerate_app_token**](docs/TokensApiControllerApi.md#regenerate_app_token) | **POST** /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate | Regenerate app token) |
|
|
176
|
+
| *stcloud::TokensApiControllerApi* | [**update_app_token1**](docs/TokensApiControllerApi.md#update_app_token1) | **PUT** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Update app token (enable/disable) |
|
|
160
177
|
|
|
161
178
|
|
|
162
179
|
## Documentation for Models
|
|
163
180
|
|
|
164
|
-
- [
|
|
165
|
-
- [
|
|
166
|
-
- [
|
|
167
|
-
- [
|
|
168
|
-
- [
|
|
169
|
-
- [
|
|
170
|
-
- [
|
|
171
|
-
- [
|
|
172
|
-
- [
|
|
173
|
-
- [
|
|
174
|
-
- [
|
|
175
|
-
- [
|
|
176
|
-
- [
|
|
177
|
-
- [
|
|
178
|
-
- [
|
|
179
|
-
- [
|
|
180
|
-
- [
|
|
181
|
-
- [
|
|
182
|
-
- [
|
|
183
|
-
- [
|
|
184
|
-
- [
|
|
185
|
-
- [
|
|
186
|
-
- [
|
|
187
|
-
- [
|
|
188
|
-
- [
|
|
189
|
-
- [
|
|
190
|
-
- [
|
|
181
|
+
- [stcloud::AlertNotificationRequest](docs/AlertNotificationRequest.md)
|
|
182
|
+
- [stcloud::AlertRule](docs/AlertRule.md)
|
|
183
|
+
- [stcloud::AlertRuleScheduleTimeRangeDto](docs/AlertRuleScheduleTimeRangeDto.md)
|
|
184
|
+
- [stcloud::AlertRuleScheduleWeekdayDto](docs/AlertRuleScheduleWeekdayDto.md)
|
|
185
|
+
- [stcloud::App](docs/App.md)
|
|
186
|
+
- [stcloud::AppDescription](docs/AppDescription.md)
|
|
187
|
+
- [stcloud::AppMetadata](docs/AppMetadata.md)
|
|
188
|
+
- [stcloud::BasicAuthMethodDto](docs/BasicAuthMethodDto.md)
|
|
189
|
+
- [stcloud::BasicOrganizationDto](docs/BasicOrganizationDto.md)
|
|
190
|
+
- [stcloud::BillingInfo](docs/BillingInfo.md)
|
|
191
|
+
- [stcloud::CloudWatchSettings](docs/CloudWatchSettings.md)
|
|
192
|
+
- [stcloud::CreateAppInfo](docs/CreateAppInfo.md)
|
|
193
|
+
- [stcloud::CreateTokenDto](docs/CreateTokenDto.md)
|
|
194
|
+
- [stcloud::DataSeriesFilter](docs/DataSeriesFilter.md)
|
|
195
|
+
- [stcloud::DataSeriesRequest](docs/DataSeriesRequest.md)
|
|
196
|
+
- [stcloud::Error](docs/Error.md)
|
|
197
|
+
- [stcloud::FilterValue](docs/FilterValue.md)
|
|
198
|
+
- [stcloud::GenericApiResponse](docs/GenericApiResponse.md)
|
|
199
|
+
- [stcloud::Invitation](docs/Invitation.md)
|
|
200
|
+
- [stcloud::NotificationIntegration](docs/NotificationIntegration.md)
|
|
201
|
+
- [stcloud::Plan](docs/Plan.md)
|
|
202
|
+
- [stcloud::ReportInfo](docs/ReportInfo.md)
|
|
203
|
+
- [stcloud::SavedQuery](docs/SavedQuery.md)
|
|
204
|
+
- [stcloud::ServiceIntegration](docs/ServiceIntegration.md)
|
|
205
|
+
- [stcloud::SubscriptionDashboardDto](docs/SubscriptionDashboardDto.md)
|
|
206
|
+
- [stcloud::SubscriptionDto](docs/SubscriptionDto.md)
|
|
207
|
+
- [stcloud::UpdateAppInfo](docs/UpdateAppInfo.md)
|
|
208
|
+
- [stcloud::UpdateSubscriptionDto](docs/UpdateSubscriptionDto.md)
|
|
209
|
+
- [stcloud::UpdateTokenDto](docs/UpdateTokenDto.md)
|
|
210
|
+
- [stcloud::UserInfo](docs/UserInfo.md)
|
|
211
|
+
- [stcloud::UserPermissions](docs/UserPermissions.md)
|
|
212
|
+
- [stcloud::UserRole](docs/UserRole.md)
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SematextCloud::AlertNotificationRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**default_interval** | **Integer** |
|
|
7
|
-
**_end**
|
|
8
|
-
**interval**
|
|
9
|
-
**start**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| -------------------- | ----------- | --------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
6
|
+
| **default_interval** | **Integer** | | [optional] |
|
|
7
|
+
| **_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] |
|
|
8
|
+
| **interval** | **String** | | [optional] |
|
|
9
|
+
| **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] |
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**get_alert_notifications_for_app_using_post**](AlertNotificationsApi.md#get_alert_notifications_for_app_using_post)
|
|
8
|
-
[**get_alert_notifications_for_user_using_post**](AlertNotificationsApi.md#get_alert_notifications_for_user_using_post) | **POST** /users-web/api/v3/notifications/alerts
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------- |
|
|
7
|
+
| [**get_alert_notifications_for_app_using_post**](AlertNotificationsApi.md#get_alert_notifications_for_app_using_post) | **POST** /users-web/api/v3/apps/{appId}/notifications/alerts | Get alert notifications for an app |
|
|
8
|
+
| [**get_alert_notifications_for_user_using_post**](AlertNotificationsApi.md#get_alert_notifications_for_user_using_post) | **POST** /users-web/api/v3/notifications/alerts | Get alert notifications for a user |
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
# **get_alert_notifications_for_app_using_post**
|
|
@@ -45,10 +45,10 @@ end
|
|
|
45
45
|
|
|
46
46
|
### Parameters
|
|
47
47
|
|
|
48
|
-
Name
|
|
49
|
-
|
|
50
|
-
**app_id**
|
|
51
|
-
**time_interval** | [**AlertNotificationRequest**](AlertNotificationRequest.md)| Time Interval |
|
|
48
|
+
| Name | Type | Description | Notes |
|
|
49
|
+
| ----------------- | ----------------------------------------------------------- | ------------- | ----- |
|
|
50
|
+
| **app_id** | **Integer** | appId |
|
|
51
|
+
| **time_interval** | [**AlertNotificationRequest**](AlertNotificationRequest.md) | Time Interval |
|
|
52
52
|
|
|
53
53
|
### Return type
|
|
54
54
|
|
|
@@ -100,9 +100,9 @@ end
|
|
|
100
100
|
|
|
101
101
|
### Parameters
|
|
102
102
|
|
|
103
|
-
Name
|
|
104
|
-
|
|
105
|
-
**time_interval** | [**AlertNotificationRequest**](AlertNotificationRequest.md)| Time Interval |
|
|
103
|
+
| Name | Type | Description | Notes |
|
|
104
|
+
| ----------------- | ----------------------------------------------------------- | ------------- | ----- |
|
|
105
|
+
| **time_interval** | [**AlertNotificationRequest**](AlertNotificationRequest.md) | Time Interval |
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
108
108
|
|
data/docs/AlertRule.md
CHANGED
|
@@ -1,53 +1,53 @@
|
|
|
1
1
|
# SematextCloud::AlertRule
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**account_email**
|
|
7
|
-
**allowed_app_types**
|
|
8
|
-
**analyzing_time**
|
|
9
|
-
**app_display_state**
|
|
10
|
-
**app_id**
|
|
11
|
-
**app_name**
|
|
12
|
-
**app_state**
|
|
13
|
-
**app_token**
|
|
14
|
-
**app_type**
|
|
15
|
-
**back_to_normal_needed**
|
|
16
|
-
**chart_key**
|
|
17
|
-
**color**
|
|
18
|
-
**creator_email**
|
|
19
|
-
**default_agg_type**
|
|
20
|
-
**description**
|
|
21
|
-
**disallowed_app_types**
|
|
22
|
-
**enabled**
|
|
23
|
-
**estimate_operation**
|
|
24
|
-
**estimate_value**
|
|
25
|
-
**filter_values**
|
|
26
|
-
**filter_values_obj**
|
|
27
|
-
**ignore_regular_events_enabled**
|
|
28
|
-
**integrations**
|
|
29
|
-
**last_data_received_date**
|
|
30
|
-
**last_sent**
|
|
31
|
-
**last_triggered**
|
|
32
|
-
**metadata**
|
|
33
|
-
**metric_key**
|
|
34
|
-
**metric_label**
|
|
35
|
-
**min_delay_between_notifications_in_minutes** | **String**
|
|
36
|
-
**name**
|
|
37
|
-
**notification_emails**
|
|
38
|
-
**notification_integrations**
|
|
39
|
-
**notifications_enabled**
|
|
40
|
-
**query**
|
|
41
|
-
**report_name**
|
|
42
|
-
**rule_key**
|
|
43
|
-
**rule_type**
|
|
44
|
-
**runbook**
|
|
45
|
-
**saved_query_id**
|
|
46
|
-
**schedule**
|
|
47
|
-
**sematext_service**
|
|
48
|
-
**send_to_email**
|
|
49
|
-
**timezone**
|
|
50
|
-
**use_only_alert_rule_integrations**
|
|
51
|
-
**user_permissions**
|
|
52
|
-
**value_column_name**
|
|
53
|
-
**value_name**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ---------------------------------------------- | ------------------------------------------------------------------------------ | ----------- | ---------- |
|
|
6
|
+
| **account_email** | **String** | | [optional] |
|
|
7
|
+
| **allowed_app_types** | **Array<Integer>** | | [optional] |
|
|
8
|
+
| **analyzing_time** | **String** | | [optional] |
|
|
9
|
+
| **app_display_state** | **String** | | [optional] |
|
|
10
|
+
| **app_id** | **Integer** | | [optional] |
|
|
11
|
+
| **app_name** | **String** | | [optional] |
|
|
12
|
+
| **app_state** | **String** | | [optional] |
|
|
13
|
+
| **app_token** | **String** | | [optional] |
|
|
14
|
+
| **app_type** | **String** | | [optional] |
|
|
15
|
+
| **back_to_normal_needed** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **chart_key** | **String** | | [optional] |
|
|
17
|
+
| **color** | **String** | | [optional] |
|
|
18
|
+
| **creator_email** | **String** | | [optional] |
|
|
19
|
+
| **default_agg_type** | **String** | | [optional] |
|
|
20
|
+
| **description** | **String** | | [optional] |
|
|
21
|
+
| **disallowed_app_types** | **Array<Integer>** | | [optional] |
|
|
22
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
|
23
|
+
| **estimate_operation** | **String** | | [optional] |
|
|
24
|
+
| **estimate_value** | **Float** | | [optional] |
|
|
25
|
+
| **filter_values** | **String** | | [optional] |
|
|
26
|
+
| **filter_values_obj** | [**Array<FilterValue>**](FilterValue.md) | | [optional] |
|
|
27
|
+
| **ignore_regular_events_enabled** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **integrations** | **String** | | [optional] |
|
|
29
|
+
| **last_data_received_date** | **Integer** | | [optional] |
|
|
30
|
+
| **last_sent** | **Integer** | | [optional] |
|
|
31
|
+
| **last_triggered** | **Integer** | | [optional] |
|
|
32
|
+
| **metadata** | **Object** | | [optional] |
|
|
33
|
+
| **metric_key** | **String** | | [optional] |
|
|
34
|
+
| **metric_label** | **String** | | [optional] |
|
|
35
|
+
| **min_delay_between_notifications_in_minutes** | **String** | | [optional] |
|
|
36
|
+
| **name** | **String** | | [optional] |
|
|
37
|
+
| **notification_emails** | **Array<String>** | | [optional] |
|
|
38
|
+
| **notification_integrations** | [**Array<NotificationIntegration>**](NotificationIntegration.md) | | [optional] |
|
|
39
|
+
| **notifications_enabled** | **BOOLEAN** | | [optional] |
|
|
40
|
+
| **query** | **String** | | [optional] |
|
|
41
|
+
| **report_name** | **String** | | [optional] |
|
|
42
|
+
| **rule_key** | **Integer** | | [optional] |
|
|
43
|
+
| **rule_type** | **String** | | [optional] |
|
|
44
|
+
| **runbook** | **String** | | [optional] |
|
|
45
|
+
| **saved_query_id** | **Integer** | | [optional] |
|
|
46
|
+
| **schedule** | [**Array<AlertRuleScheduleWeekdayDto>**](AlertRuleScheduleWeekdayDto.md) | | [optional] |
|
|
47
|
+
| **sematext_service** | **String** | | [optional] |
|
|
48
|
+
| **send_to_email** | **String** | | [optional] |
|
|
49
|
+
| **timezone** | **String** | | [optional] |
|
|
50
|
+
| **use_only_alert_rule_integrations** | **BOOLEAN** | | [optional] |
|
|
51
|
+
| **user_permissions** | [**UserPermissions**](UserPermissions.md) | | [optional] |
|
|
52
|
+
| **value_column_name** | **String** | | [optional] |
|
|
53
|
+
| **value_name** | **String** | | [optional] |
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SematextCloud::AlertRuleScheduleTimeRangeDto
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**_end**
|
|
7
|
-
**start** | **String** |
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| --------- | ---------- | ----------- | ---------- |
|
|
6
|
+
| **_end** | **String** | | [optional] |
|
|
7
|
+
| **start** | **String** | | [optional] |
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# SematextCloud::AlertRuleScheduleWeekdayDto
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**day**
|
|
7
|
-
**index**
|
|
8
|
-
**intervals** | [**Array<AlertRuleScheduleTimeRangeDto>**](AlertRuleScheduleTimeRangeDto.md) |
|
|
9
|
-
**label**
|
|
10
|
-
**type**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------- | ---------------------------------------------------------------------------------- | ----------- | ---------- |
|
|
6
|
+
| **day** | **String** | | [optional] |
|
|
7
|
+
| **index** | **Integer** | | [optional] |
|
|
8
|
+
| **intervals** | [**Array<AlertRuleScheduleTimeRangeDto>**](AlertRuleScheduleTimeRangeDto.md) | | [optional] |
|
|
9
|
+
| **label** | **String** | | [optional] |
|
|
10
|
+
| **type** | **String** | | [optional] |
|
data/docs/AlertsApi.md
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**create_alert_using_post**](AlertsApi.md#create_alert_using_post)
|
|
8
|
-
[**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete)
|
|
9
|
-
[**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put)
|
|
10
|
-
[**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put)
|
|
11
|
-
[**get_alert_rules_for_app_using_get**](AlertsApi.md#get_alert_rules_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/alerts
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------- |
|
|
7
|
+
| [**create_alert_using_post**](AlertsApi.md#create_alert_using_post) | **POST** /users-web/api/v3/alerts | Create alert rule |
|
|
8
|
+
| [**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete) | **DELETE** /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule |
|
|
9
|
+
| [**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule |
|
|
10
|
+
| [**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule |
|
|
11
|
+
| [**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 |
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
# **create_alert_using_post**
|
|
@@ -44,9 +44,9 @@ end
|
|
|
44
44
|
|
|
45
45
|
### Parameters
|
|
46
46
|
|
|
47
|
-
Name
|
|
48
|
-
|
|
49
|
-
**dto** | [**AlertRule**](AlertRule.md)| dto
|
|
47
|
+
| Name | Type | Description | Notes |
|
|
48
|
+
| ------- | ----------------------------- | ----------- | ----- |
|
|
49
|
+
| **dto** | [**AlertRule**](AlertRule.md) | dto |
|
|
50
50
|
|
|
51
51
|
### Return type
|
|
52
52
|
|
|
@@ -96,9 +96,9 @@ end
|
|
|
96
96
|
|
|
97
97
|
### Parameters
|
|
98
98
|
|
|
99
|
-
Name
|
|
100
|
-
|
|
101
|
-
**updateable_alert_id** | **Integer
|
|
99
|
+
| Name | Type | Description | Notes |
|
|
100
|
+
| ----------------------- | ----------- | ----------------- | ----- |
|
|
101
|
+
| **updateable_alert_id** | **Integer** | updateableAlertId |
|
|
102
102
|
|
|
103
103
|
### Return type
|
|
104
104
|
|
|
@@ -148,9 +148,9 @@ end
|
|
|
148
148
|
|
|
149
149
|
### Parameters
|
|
150
150
|
|
|
151
|
-
Name
|
|
152
|
-
|
|
153
|
-
**updateable_alert_id** | **Integer
|
|
151
|
+
| Name | Type | Description | Notes |
|
|
152
|
+
| ----------------------- | ----------- | ----------------- | ----- |
|
|
153
|
+
| **updateable_alert_id** | **Integer** | updateableAlertId |
|
|
154
154
|
|
|
155
155
|
### Return type
|
|
156
156
|
|
|
@@ -200,9 +200,9 @@ end
|
|
|
200
200
|
|
|
201
201
|
### Parameters
|
|
202
202
|
|
|
203
|
-
Name
|
|
204
|
-
|
|
205
|
-
**updateable_alert_id** | **Integer
|
|
203
|
+
| Name | Type | Description | Notes |
|
|
204
|
+
| ----------------------- | ----------- | ----------------- | ----- |
|
|
205
|
+
| **updateable_alert_id** | **Integer** | updateableAlertId |
|
|
206
206
|
|
|
207
207
|
### Return type
|
|
208
208
|
|
|
@@ -252,9 +252,9 @@ end
|
|
|
252
252
|
|
|
253
253
|
### Parameters
|
|
254
254
|
|
|
255
|
-
Name
|
|
256
|
-
|
|
257
|
-
**app_id** | **Integer
|
|
255
|
+
| Name | Type | Description | Notes |
|
|
256
|
+
| ---------- | ----------- | ----------- | ----- |
|
|
257
|
+
| **app_id** | **Integer** | appId |
|
|
258
258
|
|
|
259
259
|
### Return type
|
|
260
260
|
|