SematextCloud 0.1.0 → 0.1.5

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.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +135 -72
  4. data/SematextCloud.gemspec +2 -2
  5. data/docs/AlertNotificationRequest.md +6 -6
  6. data/docs/AlertNotificationsApi.md +11 -11
  7. data/docs/AlertRule.md +50 -50
  8. data/docs/AlertRuleScheduleTimeRangeDto.md +4 -4
  9. data/docs/AlertRuleScheduleWeekdayDto.md +7 -7
  10. data/docs/AlertsApi.md +22 -22
  11. data/docs/App.md +33 -29
  12. data/docs/AppDescription.md +3 -3
  13. data/docs/AppMetadata.md +7 -7
  14. data/docs/AppsApi.md +23 -23
  15. data/docs/AwsSettingsControllerApi.md +7 -7
  16. data/docs/BasicAuthMethodDto.md +4 -4
  17. data/docs/BasicOrganizationDto.md +6 -6
  18. data/docs/BillingApi.md +18 -18
  19. data/docs/BillingInfo.md +5 -5
  20. data/docs/CloudWatchSettings.md +6 -6
  21. data/docs/CreateAppInfo.md +7 -7
  22. data/docs/CreateTokenDto.md +7 -0
  23. data/docs/DataSeriesFilter.md +5 -5
  24. data/docs/DataSeriesRequest.md +9 -9
  25. data/docs/Error.md +4 -4
  26. data/docs/FilterValue.md +8 -8
  27. data/docs/GenericApiResponse.md +6 -6
  28. data/docs/Invitation.md +12 -12
  29. data/docs/LogsAppApi.md +6 -6
  30. data/docs/MetricsApi.md +20 -20
  31. data/docs/MonitoringAppApi.md +6 -6
  32. data/docs/NotificationIntegration.md +12 -12
  33. data/docs/Plan.md +15 -15
  34. data/docs/ReportInfo.md +10 -10
  35. data/docs/ResetPasswordApi.md +6 -6
  36. data/docs/SavedQueriesApi.md +19 -19
  37. data/docs/SavedQuery.md +15 -15
  38. data/docs/ServiceIntegration.md +14 -14
  39. data/docs/SubscriptionDashboardDto.md +16 -0
  40. data/docs/SubscriptionDto.md +17 -0
  41. data/docs/SubscriptionsApi.md +468 -32
  42. data/docs/TagApiControllerApi.md +34 -34
  43. data/docs/TokensApiControllerApi.md +285 -0
  44. data/docs/UpdateAppInfo.md +11 -11
  45. data/docs/UpdateSubscriptionDto.md +6 -0
  46. data/docs/UpdateTokenDto.md +6 -0
  47. data/docs/UserInfo.md +3 -3
  48. data/docs/UserPermissions.md +5 -5
  49. data/docs/UserRole.md +5 -5
  50. data/lib/SematextCloud/api/apps_api.rb +52 -0
  51. data/lib/SematextCloud/api/subscriptions_api.rb +463 -17
  52. data/lib/SematextCloud/api/tokens_api_controller_api.rb +313 -0
  53. data/lib/SematextCloud/models/create_token_dto.rb +192 -0
  54. data/lib/SematextCloud/models/subscription_dashboard_dto.rb +319 -0
  55. data/lib/SematextCloud/models/subscription_dto.rb +328 -0
  56. data/lib/SematextCloud/models/update_subscription_dto.rb +183 -0
  57. data/lib/SematextCloud/models/update_token_dto.rb +183 -0
  58. data/lib/SematextCloud/version.rb +1 -1
  59. data/spec/api/tokens_api_controller_api_spec.rb +95 -0
  60. data/spec/models/create_token_dto_spec.rb +47 -0
  61. data/spec/models/subscription_dashboard_dto_spec.rb +109 -0
  62. data/spec/models/subscription_dto_spec.rb +115 -0
  63. data/spec/models/update_subscription_dto_spec.rb +41 -0
  64. data/spec/models/update_token_dto_spec.rb +41 -0
  65. metadata +54 -29
data/docs/TagApiControllerApi.md CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  All URIs are relative to *https://localhost*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_tag_names_using_get**](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.
8
- [**get_using_get1**](TagApiControllerApi.md#get_using_get1) | **GET** /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame.
9
- [**get_using_get2**](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.
5
+ | Method | HTTP request | Description |
6
+ | ----------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
7
+ | [**get_tag_names_using_get**](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. |
8
+ | [**get_using_get1**](TagApiControllerApi.md#get_using_get1) | **GET** /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
9
+ | [**get_using_get2**](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. |
10
10
 
11
11
 
12
12
  # **get_tag_names_using_get**
@@ -50,15 +50,15 @@ end
50
50
 
51
51
  ### Parameters
52
52
 
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **app_ids** | **String**| appIds |
56
- **from** | **Integer**| from | [optional]
57
- **to** | **Integer**| to | [optional]
58
- **metrics** | **BOOLEAN**| metrics | [optional] [default to true]
59
- **logs** | **BOOLEAN**| logs | [optional] [default to true]
60
- **events** | **BOOLEAN**| events | [optional] [default to false]
61
- **rum** | **BOOLEAN**| rum | [optional] [default to true]
53
+ | Name | Type | Description | Notes |
54
+ | ----------- | ----------- | ----------- | ----------------------------- |
55
+ | **app_ids** | **String** | appIds |
56
+ | **from** | **Integer** | from | [optional] |
57
+ | **to** | **Integer** | to | [optional] |
58
+ | **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
59
+ | **logs** | **BOOLEAN** | logs | [optional] [default to true] |
60
+ | **events** | **BOOLEAN** | events | [optional] [default to false] |
61
+ | **rum** | **BOOLEAN** | rum | [optional] [default to true] |
62
62
 
63
63
  ### Return type
64
64
 
@@ -118,16 +118,16 @@ end
118
118
 
119
119
  ### Parameters
120
120
 
121
- Name | Type | Description | Notes
122
- ------------- | ------------- | ------------- | -------------
123
- **app_ids** | **String**| appIds |
124
- **tag** | [**Array<String>**](String.md)| tag |
125
- **from** | **Integer**| from | [optional]
126
- **to** | **Integer**| to | [optional]
127
- **metrics** | **BOOLEAN**| metrics | [optional] [default to true]
128
- **logs** | **BOOLEAN**| logs | [optional] [default to true]
129
- **events** | **BOOLEAN**| events | [optional] [default to false]
130
- **rum** | **BOOLEAN**| rum | [optional] [default to true]
121
+ | Name | Type | Description | Notes |
122
+ | ----------- | ------------------------------------ | ----------- | ----------------------------- |
123
+ | **app_ids** | **String** | appIds |
124
+ | **tag** | [**Array<String>**](String.md) | tag |
125
+ | **from** | **Integer** | from | [optional] |
126
+ | **to** | **Integer** | to | [optional] |
127
+ | **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
128
+ | **logs** | **BOOLEAN** | logs | [optional] [default to true] |
129
+ | **events** | **BOOLEAN** | events | [optional] [default to false] |
130
+ | **rum** | **BOOLEAN** | rum | [optional] [default to true] |
131
131
 
132
132
  ### Return type
133
133
 
@@ -187,16 +187,16 @@ end
187
187
 
188
188
  ### Parameters
189
189
 
190
- Name | Type | Description | Notes
191
- ------------- | ------------- | ------------- | -------------
192
- **app_ids** | **String**| appIds |
193
- **tag** | [**Array<String>**](String.md)| tag |
194
- **from** | **Integer**| from | [optional]
195
- **to** | **Integer**| to | [optional]
196
- **metrics** | **BOOLEAN**| metrics | [optional] [default to true]
197
- **logs** | **BOOLEAN**| logs | [optional] [default to true]
198
- **events** | **BOOLEAN**| events | [optional] [default to false]
199
- **rum** | **BOOLEAN**| rum | [optional] [default to true]
190
+ | Name | Type | Description | Notes |
191
+ | ----------- | ------------------------------------ | ----------- | ----------------------------- |
192
+ | **app_ids** | **String** | appIds |
193
+ | **tag** | [**Array<String>**](String.md) | tag |
194
+ | **from** | **Integer** | from | [optional] |
195
+ | **to** | **Integer** | to | [optional] |
196
+ | **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
197
+ | **logs** | **BOOLEAN** | logs | [optional] [default to true] |
198
+ | **events** | **BOOLEAN** | events | [optional] [default to false] |
199
+ | **rum** | **BOOLEAN** | rum | [optional] [default to true] |
200
200
 
201
201
  ### Return type
202
202
 
data/docs/TokensApiControllerApi.md ADDED
@@ -0,0 +1,285 @@
1
+ # stcloud::TokensApiControllerApi
2
+
3
+ All URIs are relative to *https://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | -------------------------------------------------------------------------- | ------------------------------------------------------------------- | --------------------------------- |
7
+ | [**create_app_token**](TokensApiControllerApi.md#create_app_token) | **POST** /users-web/api/v3/apps/{appId}/tokens | Create new app token |
8
+ | [**delete_app_token1**](TokensApiControllerApi.md#delete_app_token1) | **DELETE** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Delete app token |
9
+ | [**get_app_tokens1**](TokensApiControllerApi.md#get_app_tokens1) | **GET** /users-web/api/v3/apps/{appId}/tokens | Get app available tokens |
10
+ | [**regenerate_app_token**](TokensApiControllerApi.md#regenerate_app_token) | **POST** /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate | Regenerate app token) |
11
+ | [**update_app_token1**](TokensApiControllerApi.md#update_app_token1) | **PUT** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Update app token (enable/disable) |
12
+
13
+
14
+ # **create_app_token**
15
+ > GenericApiResponse create_app_token(app_id, dto)
16
+
17
+ Create new app token
18
+
19
+ ### Example
20
+ ```ruby
21
+ # load the gem
22
+ require 'stcloud'
23
+ # setup authorization
24
+ stcloud.configure do |config|
25
+ # Configure API key authorization: api_key
26
+ config.api_key['Authorization'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ #config.api_key_prefix['Authorization'] = 'Bearer'
29
+ end
30
+
31
+ api_instance = stcloud::TokensApiControllerApi.new
32
+
33
+ app_id = 789 # Integer | appId
34
+
35
+ dto = stcloud::CreateTokenDto.new # CreateTokenDto | dto
36
+
37
+
38
+ begin
39
+ #Create new app token
40
+ result = api_instance.create_app_token(app_id, dto)
41
+ p result
42
+ rescue stcloud::ApiError => e
43
+ puts "Exception when calling TokensApiControllerApi->create_app_token: #{e}"
44
+ end
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ | Name | Type | Description | Notes |
50
+ | ---------- | --------------------------------------- | ----------- | ----- |
51
+ | **app_id** | **Integer** | appId |
52
+ | **dto** | [**CreateTokenDto**](CreateTokenDto.md) | dto |
53
+
54
+ ### Return type
55
+
56
+ [**GenericApiResponse**](GenericApiResponse.md)
57
+
58
+ ### Authorization
59
+
60
+ [api_key](../README.md#api_key)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json
65
+ - **Accept**: application/json
66
+
67
+
68
+
69
+ # **delete_app_token1**
70
+ > GenericApiResponse delete_app_token1(app_id, token_id)
71
+
72
+ Delete app token
73
+
74
+ ### Example
75
+ ```ruby
76
+ # load the gem
77
+ require 'stcloud'
78
+ # setup authorization
79
+ stcloud.configure do |config|
80
+ # Configure API key authorization: api_key
81
+ config.api_key['Authorization'] = 'YOUR API KEY'
82
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
83
+ #config.api_key_prefix['Authorization'] = 'Bearer'
84
+ end
85
+
86
+ api_instance = stcloud::TokensApiControllerApi.new
87
+
88
+ app_id = 789 # Integer | appId
89
+
90
+ token_id = 789 # Integer | tokenId
91
+
92
+
93
+ begin
94
+ #Delete app token
95
+ result = api_instance.delete_app_token1(app_id, token_id)
96
+ p result
97
+ rescue stcloud::ApiError => e
98
+ puts "Exception when calling TokensApiControllerApi->delete_app_token1: #{e}"
99
+ end
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ | Name | Type | Description | Notes |
105
+ | ------------ | ----------- | ----------- | ----- |
106
+ | **app_id** | **Integer** | appId |
107
+ | **token_id** | **Integer** | tokenId |
108
+
109
+ ### Return type
110
+
111
+ [**GenericApiResponse**](GenericApiResponse.md)
112
+
113
+ ### Authorization
114
+
115
+ [api_key](../README.md#api_key)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: application/json
120
+ - **Accept**: application/json
121
+
122
+
123
+
124
+ # **get_app_tokens1**
125
+ > GenericApiResponse get_app_tokens1(app_id)
126
+
127
+ Get app available tokens
128
+
129
+ ### Example
130
+ ```ruby
131
+ # load the gem
132
+ require 'stcloud'
133
+ # setup authorization
134
+ stcloud.configure do |config|
135
+ # Configure API key authorization: api_key
136
+ config.api_key['Authorization'] = 'YOUR API KEY'
137
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
138
+ #config.api_key_prefix['Authorization'] = 'Bearer'
139
+ end
140
+
141
+ api_instance = stcloud::TokensApiControllerApi.new
142
+
143
+ app_id = 789 # Integer | appId
144
+
145
+
146
+ begin
147
+ #Get app available tokens
148
+ result = api_instance.get_app_tokens1(app_id)
149
+ p result
150
+ rescue stcloud::ApiError => e
151
+ puts "Exception when calling TokensApiControllerApi->get_app_tokens1: #{e}"
152
+ end
153
+ ```
154
+
155
+ ### Parameters
156
+
157
+ | Name | Type | Description | Notes |
158
+ | ---------- | ----------- | ----------- | ----- |
159
+ | **app_id** | **Integer** | appId |
160
+
161
+ ### Return type
162
+
163
+ [**GenericApiResponse**](GenericApiResponse.md)
164
+
165
+ ### Authorization
166
+
167
+ [api_key](../README.md#api_key)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: application/json
172
+ - **Accept**: application/json
173
+
174
+
175
+
176
+ # **regenerate_app_token**
177
+ > GenericApiResponse regenerate_app_token(app_id, token_id)
178
+
179
+ Regenerate app token)
180
+
181
+ ### Example
182
+ ```ruby
183
+ # load the gem
184
+ require 'stcloud'
185
+ # setup authorization
186
+ stcloud.configure do |config|
187
+ # Configure API key authorization: api_key
188
+ config.api_key['Authorization'] = 'YOUR API KEY'
189
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
190
+ #config.api_key_prefix['Authorization'] = 'Bearer'
191
+ end
192
+
193
+ api_instance = stcloud::TokensApiControllerApi.new
194
+
195
+ app_id = 789 # Integer | appId
196
+
197
+ token_id = 789 # Integer | tokenId
198
+
199
+
200
+ begin
201
+ #Regenerate app token)
202
+ result = api_instance.regenerate_app_token(app_id, token_id)
203
+ p result
204
+ rescue stcloud::ApiError => e
205
+ puts "Exception when calling TokensApiControllerApi->regenerate_app_token: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ------------ | ----------- | ----------- | ----- |
213
+ | **app_id** | **Integer** | appId |
214
+ | **token_id** | **Integer** | tokenId |
215
+
216
+ ### Return type
217
+
218
+ [**GenericApiResponse**](GenericApiResponse.md)
219
+
220
+ ### Authorization
221
+
222
+ [api_key](../README.md#api_key)
223
+
224
+ ### HTTP request headers
225
+
226
+ - **Content-Type**: application/json
227
+ - **Accept**: application/json
228
+
229
+
230
+
231
+ # **update_app_token1**
232
+ > GenericApiResponse update_app_token1(app_id, token_id, dto)
233
+
234
+ Update app token (enable/disable)
235
+
236
+ ### Example
237
+ ```ruby
238
+ # load the gem
239
+ require 'stcloud'
240
+ # setup authorization
241
+ stcloud.configure do |config|
242
+ # Configure API key authorization: api_key
243
+ config.api_key['Authorization'] = 'YOUR API KEY'
244
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
245
+ #config.api_key_prefix['Authorization'] = 'Bearer'
246
+ end
247
+
248
+ api_instance = stcloud::TokensApiControllerApi.new
249
+
250
+ app_id = 789 # Integer | appId
251
+
252
+ token_id = 789 # Integer | tokenId
253
+
254
+ dto = stcloud::UpdateTokenDto.new # UpdateTokenDto | dto
255
+
256
+
257
+ begin
258
+ #Update app token (enable/disable)
259
+ result = api_instance.update_app_token1(app_id, token_id, dto)
260
+ p result
261
+ rescue stcloud::ApiError => e
262
+ puts "Exception when calling TokensApiControllerApi->update_app_token1: #{e}"
263
+ end
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+ | Name | Type | Description | Notes |
269
+ | ------------ | --------------------------------------- | ----------- | ----- |
270
+ | **app_id** | **Integer** | appId |
271
+ | **token_id** | **Integer** | tokenId |
272
+ | **dto** | [**UpdateTokenDto**](UpdateTokenDto.md) | dto |
273
+
274
+ ### Return type
275
+
276
+ [**GenericApiResponse**](GenericApiResponse.md)
277
+
278
+ ### Authorization
279
+
280
+ [api_key](../README.md#api_key)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: application/json
285
+ - **Accept**: application/json
data/docs/UpdateAppInfo.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # SematextCloud::UpdateAppInfo
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | | [optional]
7
- **ignore_percentage** | **Integer** | | [optional]
8
- **max_events** | **Integer** | | [optional]
9
- **max_limit_mb** | **Integer** | | [optional]
10
- **name** | **String** | | [optional]
11
- **sampling** | **BOOLEAN** | | [optional]
12
- **sampling_percentage** | **Integer** | | [optional]
13
- **staggering** | **BOOLEAN** | | [optional]
14
- **status** | **String** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | ----------------------- | ----------- | ----------- | ---------- |
6
+ | **description** | **String** | | [optional] |
7
+ | **ignore_percentage** | **Integer** | | [optional] |
8
+ | **max_events** | **Integer** | | [optional] |
9
+ | **max_limit_mb** | **Integer** | | [optional] |
10
+ | **name** | **String** | | [optional] |
11
+ | **sampling** | **BOOLEAN** | | [optional] |
12
+ | **sampling_percentage** | **Integer** | | [optional] |
13
+ | **staggering** | **BOOLEAN** | | [optional] |
14
+ | **status** | **String** | | [optional] |
data/docs/UpdateSubscriptionDto.md ADDED
@@ -0,0 +1,6 @@
1
+ # stcloud::UpdateSubscriptionDto
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ----------- | ----------- | ----------- | ---------- |
6
+ | **enabled** | **BOOLEAN** | | [optional] |
data/docs/UpdateTokenDto.md ADDED
@@ -0,0 +1,6 @@
1
+ # stcloud::UpdateTokenDto
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ----------- | ----------- | ----------- | ---------- |
6
+ | **enabled** | **BOOLEAN** | | [optional] |
data/docs/UserInfo.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SematextCloud::UserInfo
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **login_name** | **String** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | -------------- | ---------- | ----------- | ---------- |
6
+ | **login_name** | **String** | | [optional] |
data/docs/UserPermissions.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # SematextCloud::UserPermissions
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **can_delete** | **BOOLEAN** | | [optional]
7
- **can_edit** | **BOOLEAN** | | [optional]
8
- **can_view** | **BOOLEAN** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | -------------- | ----------- | ----------- | ---------- |
6
+ | **can_delete** | **BOOLEAN** | | [optional] |
7
+ | **can_edit** | **BOOLEAN** | | [optional] |
8
+ | **can_view** | **BOOLEAN** | | [optional] |
data/docs/UserRole.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # SematextCloud::UserRole
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **role** | **String** | | [optional]
7
- **role_status** | **String** | | [optional]
8
- **user_email** | **String** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | --------------- | ---------- | ----------- | ---------- |
6
+ | **role** | **String** | | [optional] |
7
+ | **role_status** | **String** | | [optional] |
8
+ | **user_email** | **String** | | [optional] |