SematextCloud 0.1.0 → 0.1.5
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 +135 -72
- data/SematextCloud.gemspec +2 -2
- 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 +54 -29
data/docs/DataSeriesFilter.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# SematextCloud::DataSeriesFilter
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**aggregation** | **String**
|
|
7
|
-
**multi_value** | **BOOLEAN**
|
|
8
|
-
**values**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| --------------- | ----------------------- | ----------- | ---------- |
|
|
6
|
+
| **aggregation** | **String** | | [optional] |
|
|
7
|
+
| **multi_value** | **BOOLEAN** | | [optional] |
|
|
8
|
+
| **values** | **Array<String>** | | [optional] |
|
data/docs/DataSeriesRequest.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# SematextCloud::DataSeriesRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**default_interval** | **Integer**
|
|
7
|
-
**_end**
|
|
8
|
-
**filters**
|
|
9
|
-
**granularity**
|
|
10
|
-
**interval**
|
|
11
|
-
**metric**
|
|
12
|
-
**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
|
+
| **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] |
|
|
9
|
+
| **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] |
|
|
10
|
+
| **interval** | **String** | | [optional] |
|
|
11
|
+
| **metric** | **String** | Metric name or metric group prefix |
|
|
12
|
+
| **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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SematextCloud::Error
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**code**
|
|
7
|
-
**message** | **String** |
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ----------- | ---------- | ----------- | ---------- |
|
|
6
|
+
| **code** | **String** | | [optional] |
|
|
7
|
+
| **message** | **String** | | [optional] |
|
data/docs/FilterValue.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# SematextCloud::FilterValue
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**agg_type**
|
|
7
|
-
**filter_name** | **String**
|
|
8
|
-
**key**
|
|
9
|
-
**label**
|
|
10
|
-
**name**
|
|
11
|
-
**values**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| --------------- | ----------------------- | ----------- | ---------- |
|
|
6
|
+
| **agg_type** | **String** | | [optional] |
|
|
7
|
+
| **filter_name** | **String** | | [optional] |
|
|
8
|
+
| **key** | **String** | | [optional] |
|
|
9
|
+
| **label** | **String** | | [optional] |
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
|
+
| **values** | **Array<String>** | | [optional] |
|
data/docs/GenericApiResponse.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SematextCloud::GenericApiResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**data**
|
|
7
|
-
**errors**
|
|
8
|
-
**message** | **String**
|
|
9
|
-
**success** | **BOOLEAN**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ----------- | ---------------------------------- | -------------------------------------------------------------------------------------------- | ---------- |
|
|
6
|
+
| **data** | **Object** | Contains actual data when response is successful. Key and Value is specific to each endpoint | [optional] |
|
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
|
8
|
+
| **message** | **String** | | [optional] |
|
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
data/docs/Invitation.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# SematextCloud::Invitation
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**app**
|
|
7
|
-
**apps**
|
|
8
|
-
**id**
|
|
9
|
-
**invite_date**
|
|
10
|
-
**invite_status**
|
|
11
|
-
**invitee_email**
|
|
12
|
-
**invitee_role**
|
|
13
|
-
**invitee_status** | **String**
|
|
14
|
-
**inviter_email**
|
|
15
|
-
**uuid**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------------ | ------------------------------ | ------------------------------------------------- | ---------- |
|
|
6
|
+
| **app** | [**App**](App.md) | For invite request, only app.id needs to be set. | [optional] |
|
|
7
|
+
| **apps** | [**Array<App>**](App.md) | For invite request, only apps.id needs to be set. | [optional] |
|
|
8
|
+
| **id** | **Integer** | | [optional] |
|
|
9
|
+
| **invite_date** | **DateTime** | | [optional] |
|
|
10
|
+
| **invite_status** | **String** | | [optional] |
|
|
11
|
+
| **invitee_email** | **String** | | [optional] |
|
|
12
|
+
| **invitee_role** | **String** | | [optional] |
|
|
13
|
+
| **invitee_status** | **String** | | [optional] |
|
|
14
|
+
| **inviter_email** | **String** | | [optional] |
|
|
15
|
+
| **uuid** | **String** | | [optional] |
|
data/docs/LogsAppApi.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**create_logsene_application**](LogsAppApi.md#create_logsene_application) | **POST** /logsene-reports/api/v3/apps | Create Logs App
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| -------------------------------------------------------------------------- | ------------------------------------- | --------------- |
|
|
7
|
+
| [**create_logsene_application**](LogsAppApi.md#create_logsene_application) | **POST** /logsene-reports/api/v3/apps | Create Logs App |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
# **create_logsene_application**
|
|
@@ -40,9 +40,9 @@ end
|
|
|
40
40
|
|
|
41
41
|
### Parameters
|
|
42
42
|
|
|
43
|
-
Name
|
|
44
|
-
|
|
45
|
-
**application_details** | [**CreateAppInfo**](CreateAppInfo.md)| Details of the application to be created |
|
|
43
|
+
| Name | Type | Description | Notes |
|
|
44
|
+
| ----------------------- | ------------------------------------- | ---------------------------------------- | ----- |
|
|
45
|
+
| **application_details** | [**CreateAppInfo**](CreateAppInfo.md) | Details of the application to be created |
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
data/docs/MetricsApi.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**list_data_series_using_post**](MetricsApi.md#list_data_series_using_post) | **POST** /spm-reports/api/v3/apps/{appId}/metrics/data
|
|
8
|
-
[**list_filters_using_post**](MetricsApi.md#list_filters_using_post)
|
|
9
|
-
[**list_metrics_keys_using_get**](MetricsApi.md#list_metrics_keys_using_get) | **GET** /spm-reports/api/v3/apps/{appId}/metrics/keys
|
|
10
|
-
[**list_metrics_using_get**](MetricsApi.md#list_metrics_using_get)
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ---------------------------------------------------------------------------- | --------------------------------------------------------- | ----------------------------------------------- |
|
|
7
|
+
| [**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 |
|
|
8
|
+
| [**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 |
|
|
9
|
+
| [**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 |
|
|
10
|
+
| [**list_metrics_using_get**](MetricsApi.md#list_metrics_using_get) | **GET** /spm-reports/api/v3/apps/{appId}/metrics | Get metrics info for an app |
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
# **list_data_series_using_post**
|
|
@@ -47,10 +47,10 @@ end
|
|
|
47
47
|
|
|
48
48
|
### Parameters
|
|
49
49
|
|
|
50
|
-
Name
|
|
51
|
-
|
|
52
|
-
**app_id**
|
|
53
|
-
**request_body** | [**DataSeriesRequest**](DataSeriesRequest.md)| Metric data points request |
|
|
50
|
+
| Name | Type | Description | Notes |
|
|
51
|
+
| ---------------- | --------------------------------------------- | -------------------------- | ----- |
|
|
52
|
+
| **app_id** | **Integer** | appId |
|
|
53
|
+
| **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md) | Metric data points request |
|
|
54
54
|
|
|
55
55
|
### Return type
|
|
56
56
|
|
|
@@ -104,10 +104,10 @@ end
|
|
|
104
104
|
|
|
105
105
|
### Parameters
|
|
106
106
|
|
|
107
|
-
Name
|
|
108
|
-
|
|
109
|
-
**app_id**
|
|
110
|
-
**request_body** | [**DataSeriesRequest**](DataSeriesRequest.md)| Metric filters request |
|
|
107
|
+
| Name | Type | Description | Notes |
|
|
108
|
+
| ---------------- | --------------------------------------------- | ---------------------- | ----- |
|
|
109
|
+
| **app_id** | **Integer** | appId |
|
|
110
|
+
| **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md) | Metric filters request |
|
|
111
111
|
|
|
112
112
|
### Return type
|
|
113
113
|
|
|
@@ -157,9 +157,9 @@ end
|
|
|
157
157
|
|
|
158
158
|
### Parameters
|
|
159
159
|
|
|
160
|
-
Name
|
|
161
|
-
|
|
162
|
-
**app_id** | **Integer
|
|
160
|
+
| Name | Type | Description | Notes |
|
|
161
|
+
| ---------- | ----------- | ----------- | ----- |
|
|
162
|
+
| **app_id** | **Integer** | appId |
|
|
163
163
|
|
|
164
164
|
### Return type
|
|
165
165
|
|
|
@@ -209,9 +209,9 @@ end
|
|
|
209
209
|
|
|
210
210
|
### Parameters
|
|
211
211
|
|
|
212
|
-
Name
|
|
213
|
-
|
|
214
|
-
**app_id** | **Integer
|
|
212
|
+
| Name | Type | Description | Notes |
|
|
213
|
+
| ---------- | ----------- | ----------- | ----- |
|
|
214
|
+
| **app_id** | **Integer** | appId |
|
|
215
215
|
|
|
216
216
|
### Return type
|
|
217
217
|
|
data/docs/MonitoringAppApi.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**create_spm_application1**](MonitoringAppApi.md#create_spm_application1) | **POST** /spm-reports/api/v3/apps | Create Monitoring App
|
|
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
8
|
|
|
9
9
|
|
|
10
10
|
# **create_spm_application1**
|
|
@@ -40,9 +40,9 @@ end
|
|
|
40
40
|
|
|
41
41
|
### Parameters
|
|
42
42
|
|
|
43
|
-
Name
|
|
44
|
-
|
|
45
|
-
**application_details** | [**CreateAppInfo**](CreateAppInfo.md)| Details of the application to be created |
|
|
43
|
+
| Name | Type | Description | Notes |
|
|
44
|
+
| ----------------------- | ------------------------------------- | ---------------------------------------- | ----- |
|
|
45
|
+
| **application_details** | [**CreateAppInfo**](CreateAppInfo.md) | Details of the application to be created |
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# SematextCloud::NotificationIntegration
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**applicability**
|
|
7
|
-
**create_date**
|
|
8
|
-
**created_by_owner** | **BOOLEAN**
|
|
9
|
-
**creator_id**
|
|
10
|
-
**id**
|
|
11
|
-
**integration_type** | **String**
|
|
12
|
-
**name**
|
|
13
|
-
**params**
|
|
14
|
-
**state**
|
|
15
|
-
**user_id**
|
|
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
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# SematextCloud::Plan
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**app_type**
|
|
7
|
-
**custom**
|
|
8
|
-
**data_retention_hours** | **Float**
|
|
9
|
-
**default_trial_plan**
|
|
10
|
-
**free**
|
|
11
|
-
**free_trial_days**
|
|
12
|
-
**id**
|
|
13
|
-
**max_alerts**
|
|
14
|
-
**max_daily_events**
|
|
15
|
-
**name**
|
|
16
|
-
**plan_scheme**
|
|
17
|
-
**sematext_service**
|
|
18
|
-
**trial_plan**
|
|
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
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# SematextCloud::ReportInfo
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
------------ |
|
|
6
|
-
**addresses**
|
|
7
|
-
**app_id**
|
|
8
|
-
**end_date**
|
|
9
|
-
**filters**
|
|
10
|
-
**report_name** | **String**
|
|
11
|
-
**start_date**
|
|
12
|
-
**subject**
|
|
13
|
-
**text**
|
|
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] |
|
data/docs/ResetPasswordApi.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**reset_password_using_post**](ResetPasswordApi.md#reset_password_using_post) | **POST** /users-web/api/v3/account/password/reset | Reset Password
|
|
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
8
|
|
|
9
9
|
|
|
10
10
|
# **reset_password_using_post**
|
|
@@ -40,9 +40,9 @@ end
|
|
|
40
40
|
|
|
41
41
|
### Parameters
|
|
42
42
|
|
|
43
|
-
Name
|
|
44
|
-
|
|
45
|
-
**dto** | [**UserInfo**](UserInfo.md)| dto
|
|
43
|
+
| Name | Type | Description | Notes |
|
|
44
|
+
| ------- | --------------------------- | ----------- | ----- |
|
|
45
|
+
| **dto** | [**UserInfo**](UserInfo.md) | dto |
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
data/docs/SavedQueriesApi.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**delete_saved_query_using_delete**](SavedQueriesApi.md#delete_saved_query_using_delete)
|
|
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
|
|
9
|
-
[**save_query_using_post**](SavedQueriesApi.md#save_query_using_post)
|
|
10
|
-
[**save_query_using_put**](SavedQueriesApi.md#save_query_using_put)
|
|
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
11
|
|
|
12
12
|
|
|
13
13
|
# **delete_saved_query_using_delete**
|
|
@@ -43,9 +43,9 @@ end
|
|
|
43
43
|
|
|
44
44
|
### Parameters
|
|
45
45
|
|
|
46
|
-
Name
|
|
47
|
-
|
|
48
|
-
**updateable_query_id** | **Integer
|
|
46
|
+
| Name | Type | Description | Notes |
|
|
47
|
+
| ----------------------- | ----------- | ----------------- | ----- |
|
|
48
|
+
| **updateable_query_id** | **Integer** | updateableQueryId |
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
51
51
|
|
|
@@ -95,9 +95,9 @@ end
|
|
|
95
95
|
|
|
96
96
|
### Parameters
|
|
97
97
|
|
|
98
|
-
Name
|
|
99
|
-
|
|
100
|
-
**app_id** | **Integer
|
|
98
|
+
| Name | Type | Description | Notes |
|
|
99
|
+
| ---------- | ----------- | ----------- | ----- |
|
|
100
|
+
| **app_id** | **Integer** | appId |
|
|
101
101
|
|
|
102
102
|
### Return type
|
|
103
103
|
|
|
@@ -147,9 +147,9 @@ end
|
|
|
147
147
|
|
|
148
148
|
### Parameters
|
|
149
149
|
|
|
150
|
-
Name
|
|
151
|
-
|
|
152
|
-
**saved_query_dto** | [**SavedQuery**](SavedQuery.md)| savedQueryDto |
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ------------------- | ------------------------------- | ------------- | ----- |
|
|
152
|
+
| **saved_query_dto** | [**SavedQuery**](SavedQuery.md) | savedQueryDto |
|
|
153
153
|
|
|
154
154
|
### Return type
|
|
155
155
|
|
|
@@ -201,10 +201,10 @@ end
|
|
|
201
201
|
|
|
202
202
|
### Parameters
|
|
203
203
|
|
|
204
|
-
Name
|
|
205
|
-
|
|
206
|
-
**saved_query_dto**
|
|
207
|
-
**updateable_query_id** | **Integer
|
|
204
|
+
| Name | Type | Description | Notes |
|
|
205
|
+
| ----------------------- | ------------------------------- | ----------------- | ----- |
|
|
206
|
+
| **saved_query_dto** | [**SavedQuery**](SavedQuery.md) | savedQueryDto |
|
|
207
|
+
| **updateable_query_id** | **Integer** | updateableQueryId |
|
|
208
208
|
|
|
209
209
|
### Return type
|
|
210
210
|
|
data/docs/SavedQuery.md
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# SematextCloud::SavedQuery
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**alert_rule**
|
|
7
|
-
**allow_modification** | **BOOLEAN**
|
|
8
|
-
**application_id**
|
|
9
|
-
**application_name**
|
|
10
|
-
**application_token**
|
|
11
|
-
**creator_email**
|
|
12
|
-
**id**
|
|
13
|
-
**label_color**
|
|
14
|
-
**logsene_alert_type** | **Object**
|
|
15
|
-
**owner_email**
|
|
16
|
-
**query_name**
|
|
17
|
-
**query_string**
|
|
18
|
-
**user_permissions**
|
|
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] |
|