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
data/docs/App.md
CHANGED
|
@@ -1,32 +1,36 @@
|
|
|
1
1
|
# SematextCloud::App
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**ajax_threshold**
|
|
7
|
-
**app_type**
|
|
8
|
-
**app_type_id**
|
|
9
|
-
**creator_email**
|
|
10
|
-
**credit_card_expiry**
|
|
11
|
-
**credit_card_number**
|
|
12
|
-
**description**
|
|
13
|
-
**display_status**
|
|
14
|
-
**first_data_saved_date**
|
|
15
|
-
**id**
|
|
16
|
-
**integration**
|
|
17
|
-
**last_data_received_date** | **Integer**
|
|
18
|
-
**last_data_saved_date**
|
|
19
|
-
**logged_in_user_app_role** | **String**
|
|
20
|
-
**monthly_invoice_account** | **BOOLEAN**
|
|
21
|
-
**name**
|
|
22
|
-
**owner_email**
|
|
23
|
-
**owning_organization**
|
|
24
|
-
**page_load_threshold**
|
|
25
|
-
**payment_method_id**
|
|
26
|
-
**plan**
|
|
27
|
-
**prepaid_account**
|
|
28
|
-
**
|
|
29
|
-
**
|
|
30
|
-
**
|
|
31
|
-
**
|
|
32
|
-
**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| --------------------------- | --------------------------------------------------- | ----------- | ---------- |
|
|
6
|
+
| **ajax_threshold** | **Integer** | | [optional] |
|
|
7
|
+
| **app_type** | **String** | | [optional] |
|
|
8
|
+
| **app_type_id** | **Integer** | | [optional] |
|
|
9
|
+
| **creator_email** | **String** | | [optional] |
|
|
10
|
+
| **credit_card_expiry** | **String** | | [optional] |
|
|
11
|
+
| **credit_card_number** | **String** | | [optional] |
|
|
12
|
+
| **description** | **String** | | [optional] |
|
|
13
|
+
| **display_status** | **String** | | [optional] |
|
|
14
|
+
| **first_data_saved_date** | **Integer** | | [optional] |
|
|
15
|
+
| **id** | **Integer** | | [optional] |
|
|
16
|
+
| **integration** | [**ServiceIntegration**](ServiceIntegration.md) | | [optional] |
|
|
17
|
+
| **last_data_received_date** | **Integer** | | [optional] |
|
|
18
|
+
| **last_data_saved_date** | **Integer** | | [optional] |
|
|
19
|
+
| **logged_in_user_app_role** | **String** | | [optional] |
|
|
20
|
+
| **monthly_invoice_account** | **BOOLEAN** | | [optional] |
|
|
21
|
+
| **name** | **String** | | [optional] |
|
|
22
|
+
| **owner_email** | **String** | | [optional] |
|
|
23
|
+
| **owning_organization** | [**BasicOrganizationDto**](BasicOrganizationDto.md) | | [optional] |
|
|
24
|
+
| **page_load_threshold** | **Integer** | | [optional] |
|
|
25
|
+
| **payment_method_id** | **Integer** | | [optional] |
|
|
26
|
+
| **plan** | [**Plan**](Plan.md) | | [optional] |
|
|
27
|
+
| **prepaid_account** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **read_token** | **String** | | [optional] |
|
|
29
|
+
| **read_write_token** | **String** | | [optional] |
|
|
30
|
+
| **registration_date** | **Integer** | | [optional] |
|
|
31
|
+
| **status** | **String** | | [optional] |
|
|
32
|
+
| **token** | **String** | | [optional] |
|
|
33
|
+
| **trial_end_date** | **Integer** | | [optional] |
|
|
34
|
+
| **url_group_limit** | **Integer** | | [optional] |
|
|
35
|
+
| **user_roles** | [**Array<UserRole>**](UserRole.md) | | [optional] |
|
|
36
|
+
| **write_token** | **String** | | [optional] |
|
data/docs/AppDescription.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SematextCloud::AppDescription
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**description** | **String** |
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| --------------- | ---------- | ----------- | ---------- |
|
|
6
|
+
| **description** | **String** | | [optional] |
|
data/docs/AppMetadata.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# SematextCloud::AppMetadata
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**aws_cloud_watch_access_key** | **String**
|
|
7
|
-
**aws_cloud_watch_secret_key** | **String**
|
|
8
|
-
**aws_fetch_frequency**
|
|
9
|
-
**aws_region**
|
|
10
|
-
**sub_types**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------------------------ | ----------------------- | ---------------------------------------------------------- | ---------- |
|
|
6
|
+
| **aws_cloud_watch_access_key** | **String** | | [optional] |
|
|
7
|
+
| **aws_cloud_watch_secret_key** | **String** | | [optional] |
|
|
8
|
+
| **aws_fetch_frequency** | **String** | | [optional] |
|
|
9
|
+
| **aws_region** | **String** | | [optional] |
|
|
10
|
+
| **sub_types** | **Array<String>** | Comma separated list of AWS types monitored by created app | [optional] |
|
data/docs/AppsApi.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**get_app_types_using_get**](AppsApi.md#get_app_types_using_get)
|
|
8
|
-
[**get_using_get**](AppsApi.md#get_using_get)
|
|
9
|
-
[**invite_app_guests_using_post**](AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests
|
|
10
|
-
[**list_apps_users_using_get**](AppsApi.md#list_apps_users_using_get)
|
|
11
|
-
[**list_using_get**](AppsApi.md#list_using_get)
|
|
12
|
-
[**update_description_using_put**](AppsApi.md#update_description_using_put) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app
|
|
13
|
-
[**update_using_put1**](AppsApi.md#update_using_put1)
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| --------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
7
|
+
| [**get_app_types_using_get**](AppsApi.md#get_app_types_using_get) | **GET** /users-web/api/v3/apps/types | Get all App types supported for the account identified with apiKey |
|
|
8
|
+
| [**get_using_get**](AppsApi.md#get_using_get) | **GET** /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App |
|
|
9
|
+
| [**invite_app_guests_using_post**](AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests | Invite guests to an app |
|
|
10
|
+
| [**list_apps_users_using_get**](AppsApi.md#list_apps_users_using_get) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account |
|
|
11
|
+
| [**list_using_get**](AppsApi.md#list_using_get) | **GET** /users-web/api/v3/apps | Get all apps accessible by account identified with apiKey |
|
|
12
|
+
| [**update_description_using_put**](AppsApi.md#update_description_using_put) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app |
|
|
13
|
+
| [**update_using_put1**](AppsApi.md#update_using_put1) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app |
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
# **get_app_types_using_get**
|
|
@@ -92,9 +92,9 @@ end
|
|
|
92
92
|
|
|
93
93
|
### Parameters
|
|
94
94
|
|
|
95
|
-
Name
|
|
96
|
-
|
|
97
|
-
**any_state_app_id** | **Integer
|
|
95
|
+
| Name | Type | Description | Notes |
|
|
96
|
+
| -------------------- | ----------- | ------------- | ----- |
|
|
97
|
+
| **any_state_app_id** | **Integer** | anyStateAppId |
|
|
98
98
|
|
|
99
99
|
### Return type
|
|
100
100
|
|
|
@@ -144,9 +144,9 @@ end
|
|
|
144
144
|
|
|
145
145
|
### Parameters
|
|
146
146
|
|
|
147
|
-
Name
|
|
148
|
-
|
|
149
|
-
**invitation** | [**Invitation**](Invitation.md)| For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values |
|
|
147
|
+
| Name | Type | Description | Notes |
|
|
148
|
+
| -------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
|
149
|
+
| **invitation** | [**Invitation**](Invitation.md) | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values |
|
|
150
150
|
|
|
151
151
|
### Return type
|
|
152
152
|
|
|
@@ -293,10 +293,10 @@ end
|
|
|
293
293
|
|
|
294
294
|
### Parameters
|
|
295
295
|
|
|
296
|
-
Name
|
|
297
|
-
|
|
298
|
-
**any_state_app_id** | **Integer
|
|
299
|
-
**update_details**
|
|
296
|
+
| Name | Type | Description | Notes |
|
|
297
|
+
| -------------------- | --------------------------------------- | -------------- | ---------- |
|
|
298
|
+
| **any_state_app_id** | **Integer** | App Id |
|
|
299
|
+
| **update_details** | [**AppDescription**](AppDescription.md) | Update Details | [optional] |
|
|
300
300
|
|
|
301
301
|
### Return type
|
|
302
302
|
|
|
@@ -350,10 +350,10 @@ end
|
|
|
350
350
|
|
|
351
351
|
### Parameters
|
|
352
352
|
|
|
353
|
-
Name
|
|
354
|
-
|
|
355
|
-
**dto**
|
|
356
|
-
**any_state_app_id** | **Integer
|
|
353
|
+
| Name | Type | Description | Notes |
|
|
354
|
+
| -------------------- | ------------------------------------- | ----------- | ----- |
|
|
355
|
+
| **dto** | [**UpdateAppInfo**](UpdateAppInfo.md) | dto |
|
|
356
|
+
| **any_state_app_id** | **Integer** | App Id |
|
|
357
357
|
|
|
358
358
|
### Return type
|
|
359
359
|
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**update_using_put**](AwsSettingsControllerApi.md#update_using_put) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| -------------------------------------------------------------------- | ------------------------------------------ | ---------------------------------------- |
|
|
7
|
+
| [**update_using_put**](AwsSettingsControllerApi.md#update_using_put) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
# **update_using_put**
|
|
@@ -44,10 +44,10 @@ end
|
|
|
44
44
|
|
|
45
45
|
### Parameters
|
|
46
46
|
|
|
47
|
-
Name
|
|
48
|
-
|
|
49
|
-
**app_id** | **Integer
|
|
50
|
-
**dto**
|
|
47
|
+
| Name | Type | Description | Notes |
|
|
48
|
+
| ---------- | ----------------------------------------------- | ----------- | ----- |
|
|
49
|
+
| **app_id** | **Integer** | appId |
|
|
50
|
+
| **dto** | [**CloudWatchSettings**](CloudWatchSettings.md) | dto |
|
|
51
51
|
|
|
52
52
|
### Return type
|
|
53
53
|
|
data/docs/BasicAuthMethodDto.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SematextCloud::BasicAuthMethodDto
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**auth_type** | **String** |
|
|
7
|
-
**uuid**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------- | ---------- | ----------- | ---------- |
|
|
6
|
+
| **auth_type** | **String** | | [optional] |
|
|
7
|
+
| **uuid** | **String** | | [optional] |
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SematextCloud::BasicOrganizationDto
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) |
|
|
7
|
-
**name**
|
|
8
|
-
**status**
|
|
9
|
-
**uuid**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ---------------- | ------------------------------------------------------------ | ----------- | ---------- |
|
|
6
|
+
| **auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) | | [optional] |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **status** | **String** | | [optional] |
|
|
9
|
+
| **uuid** | **String** | | [optional] |
|
data/docs/BillingApi.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://localhost*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details
|
|
8
|
-
[**list_available_plans_using_get**](BillingApi.md#list_available_plans_using_get) | **GET** /users-web/api/v3/billing/availablePlans
|
|
9
|
-
[**update_plan_using_put**](BillingApi.md#update_plan_using_put)
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------- |
|
|
7
|
+
| [**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details |
|
|
8
|
+
| [**list_available_plans_using_get**](BillingApi.md#list_available_plans_using_get) | **GET** /users-web/api/v3/billing/availablePlans | Get available plans |
|
|
9
|
+
| [**update_plan_using_put**](BillingApi.md#update_plan_using_put) | **PUT** /users-web/api/v3/billing/info/{appId} | Update plan for an app |
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
# **get_detailed_invoice_using_get**
|
|
@@ -46,11 +46,11 @@ end
|
|
|
46
46
|
|
|
47
47
|
### Parameters
|
|
48
48
|
|
|
49
|
-
Name
|
|
50
|
-
|
|
51
|
-
**service** | **String
|
|
52
|
-
**year**
|
|
53
|
-
**month**
|
|
49
|
+
| Name | Type | Description | Notes |
|
|
50
|
+
| ----------- | ----------- | ----------- | ----- |
|
|
51
|
+
| **service** | **String** | service |
|
|
52
|
+
| **year** | **Integer** | year |
|
|
53
|
+
| **month** | **Integer** | month |
|
|
54
54
|
|
|
55
55
|
### Return type
|
|
56
56
|
|
|
@@ -102,10 +102,10 @@ end
|
|
|
102
102
|
|
|
103
103
|
### Parameters
|
|
104
104
|
|
|
105
|
-
Name
|
|
106
|
-
|
|
107
|
-
**integration_id** | **Integer
|
|
108
|
-
**app_type**
|
|
105
|
+
| Name | Type | Description | Notes |
|
|
106
|
+
| ------------------ | ----------- | ------------- | ---------- |
|
|
107
|
+
| **integration_id** | **Integer** | integrationId | [optional] |
|
|
108
|
+
| **app_type** | **String** | appType | [optional] |
|
|
109
109
|
|
|
110
110
|
### Return type
|
|
111
111
|
|
|
@@ -157,10 +157,10 @@ end
|
|
|
157
157
|
|
|
158
158
|
### Parameters
|
|
159
159
|
|
|
160
|
-
Name
|
|
161
|
-
|
|
162
|
-
**app_id** | **Integer
|
|
163
|
-
**dto**
|
|
160
|
+
| Name | Type | Description | Notes |
|
|
161
|
+
| ---------- | --------------------------------- | ----------- | ----- |
|
|
162
|
+
| **app_id** | **Integer** | appId |
|
|
163
|
+
| **dto** | [**BillingInfo**](BillingInfo.md) | dto |
|
|
164
164
|
|
|
165
165
|
### Return type
|
|
166
166
|
|
data/docs/BillingInfo.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# SematextCloud::BillingInfo
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**credit_card_id** | **Integer** |
|
|
7
|
-
**payment_method** | **String**
|
|
8
|
-
**plan_id**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------------ | ----------- | ----------- | ---------- |
|
|
6
|
+
| **credit_card_id** | **Integer** | | [optional] |
|
|
7
|
+
| **payment_method** | **String** | | [optional] |
|
|
8
|
+
| **plan_id** | **Integer** | | [optional] |
|
data/docs/CloudWatchSettings.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SematextCloud::CloudWatchSettings
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**access_key**
|
|
7
|
-
**fetch_frequency** | **String** |
|
|
8
|
-
**region**
|
|
9
|
-
**secret_key**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------------- | ---------- | ----------- | ---------- |
|
|
6
|
+
| **access_key** | **String** | | [optional] |
|
|
7
|
+
| **fetch_frequency** | **String** | | [optional] |
|
|
8
|
+
| **region** | **String** | | [optional] |
|
|
9
|
+
| **secret_key** | **String** | | [optional] |
|
data/docs/CreateAppInfo.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# SematextCloud::CreateAppInfo
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
-
Name
|
|
5
|
-
|
|
6
|
-
**app_type**
|
|
7
|
-
**discount_code**
|
|
8
|
-
**initial_plan_id** | **Integer**
|
|
9
|
-
**meta_data**
|
|
10
|
-
**name**
|
|
4
|
+
| Name | Type | Description | Notes |
|
|
5
|
+
| ------------------- | --------------------------------- | -------------------------------------------------------------- | ---------- |
|
|
6
|
+
| **app_type** | **String** | | [optional] |
|
|
7
|
+
| **discount_code** | **String** | | [optional] |
|
|
8
|
+
| **initial_plan_id** | **Integer** | | [optional] |
|
|
9
|
+
| **meta_data** | [**AppMetadata**](AppMetadata.md) | AWS app meta data. Applicable only for `aws` appType | [optional] |
|
|
10
|
+
| **name** | **String** | | [optional] |
|
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] |
|