SematextCloud 0.1.4 → 0.1.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +87 -65
  3. data/docs/AlertNotificationRequest.md +6 -6
  4. data/docs/AlertNotificationsApi.md +11 -11
  5. data/docs/AlertRule.md +50 -50
  6. data/docs/AlertRuleScheduleTimeRangeDto.md +4 -4
  7. data/docs/AlertRuleScheduleWeekdayDto.md +7 -7
  8. data/docs/AlertsApi.md +22 -22
  9. data/docs/App.md +33 -29
  10. data/docs/AppDescription.md +3 -3
  11. data/docs/AppMetadata.md +7 -7
  12. data/docs/AppsApi.md +23 -23
  13. data/docs/AwsSettingsControllerApi.md +7 -7
  14. data/docs/BasicAuthMethodDto.md +4 -4
  15. data/docs/BasicOrganizationDto.md +6 -6
  16. data/docs/BillingApi.md +18 -18
  17. data/docs/BillingInfo.md +5 -5
  18. data/docs/CloudWatchSettings.md +6 -6
  19. data/docs/CreateAppInfo.md +7 -7
  20. data/docs/CreateTokenDto.md +7 -0
  21. data/docs/DataSeriesFilter.md +5 -5
  22. data/docs/DataSeriesRequest.md +9 -9
  23. data/docs/Error.md +4 -4
  24. data/docs/FilterValue.md +8 -8
  25. data/docs/GenericApiResponse.md +6 -6
  26. data/docs/Invitation.md +12 -12
  27. data/docs/LogsAppApi.md +6 -6
  28. data/docs/MetricsApi.md +20 -20
  29. data/docs/MonitoringAppApi.md +6 -6
  30. data/docs/NotificationIntegration.md +12 -12
  31. data/docs/Plan.md +15 -15
  32. data/docs/ReportInfo.md +10 -10
  33. data/docs/ResetPasswordApi.md +6 -6
  34. data/docs/SavedQueriesApi.md +19 -19
  35. data/docs/SavedQuery.md +15 -15
  36. data/docs/ServiceIntegration.md +14 -14
  37. data/docs/SubscriptionDashboardDto.md +16 -0
  38. data/docs/SubscriptionDto.md +17 -0
  39. data/docs/SubscriptionsApi.md +468 -32
  40. data/docs/TagApiControllerApi.md +34 -34
  41. data/docs/TokensApiControllerApi.md +285 -0
  42. data/docs/UpdateAppInfo.md +11 -11
  43. data/docs/UpdateSubscriptionDto.md +6 -0
  44. data/docs/UpdateTokenDto.md +6 -0
  45. data/docs/UserInfo.md +3 -3
  46. data/docs/UserPermissions.md +5 -5
  47. data/docs/UserRole.md +5 -5
  48. data/lib/SematextCloud/api/subscriptions_api.rb +463 -17
  49. data/lib/SematextCloud/api/tokens_api_controller_api.rb +313 -0
  50. data/lib/SematextCloud/models/create_token_dto.rb +192 -0
  51. data/lib/SematextCloud/models/subscription_dashboard_dto.rb +319 -0
  52. data/lib/SematextCloud/models/subscription_dto.rb +328 -0
  53. data/lib/SematextCloud/models/update_subscription_dto.rb +183 -0
  54. data/lib/SematextCloud/models/update_token_dto.rb +183 -0
  55. data/lib/SematextCloud/version.rb +1 -1
  56. data/spec/api/tokens_api_controller_api_spec.rb +95 -0
  57. data/spec/models/create_token_dto_spec.rb +47 -0
  58. data/spec/models/subscription_dashboard_dto_spec.rb +109 -0
  59. data/spec/models/subscription_dto_spec.rb +115 -0
  60. data/spec/models/update_subscription_dto_spec.rb +41 -0
  61. data/spec/models/update_token_dto_spec.rb +41 -0
  62. metadata +53 -29
data/docs/LogsAppApi.md CHANGED
@@ -2,9 +2,9 @@
2
2
 
3
3
  All URIs are relative to *https://localhost*
4
4
 
5
- Method | HTTP request | Description
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 | Type | Description | Notes
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 | 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
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 | Type | Description | Notes
51
- ------------- | ------------- | ------------- | -------------
52
- **app_id** | **Integer**| appId |
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 | Type | Description | Notes
108
- ------------- | ------------- | ------------- | -------------
109
- **app_id** | **Integer**| appId |
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 | Type | Description | Notes
161
- ------------- | ------------- | ------------- | -------------
162
- **app_id** | **Integer**| appId |
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 | Type | Description | Notes
213
- ------------- | ------------- | ------------- | -------------
214
- **app_id** | **Integer**| appId |
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 | HTTP request | Description
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 | Type | Description | Notes
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/NotificationIntegration.md CHANGED
@@ -1,15 +1,15 @@
1
1
  # SematextCloud::NotificationIntegration
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **applicability** | **String** | | [optional]
7
- **create_date** | **DateTime** | | [optional]
8
- **created_by_owner** | **BOOLEAN** | | [optional]
9
- **creator_id** | **Integer** | | [optional]
10
- **id** | **Integer** | | [optional]
11
- **integration_type** | **String** | | [optional]
12
- **name** | **String** | | [optional]
13
- **params** | **Hash<String, String>** | | [optional]
14
- **state** | **String** | | [optional]
15
- **user_id** | **Integer** | | [optional]
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 | 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]
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 | 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]
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 | 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
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 | Type | Description | Notes
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 | 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
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 | Type | Description | Notes
47
- ------------- | ------------- | ------------- | -------------
48
- **updateable_query_id** | **Integer**| updateableQueryId |
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 | Type | Description | Notes
99
- ------------- | ------------- | ------------- | -------------
100
- **app_id** | **Integer**| appId |
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 | Type | Description | Notes
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 | Type | Description | Notes
205
- ------------- | ------------- | ------------- | -------------
206
- **saved_query_dto** | [**SavedQuery**](SavedQuery.md)| savedQueryDto |
207
- **updateable_query_id** | **Integer**| updateableQueryId |
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 | 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]
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] |
data/docs/ServiceIntegration.md CHANGED
@@ -1,17 +1,17 @@
1
1
  # SematextCloud::ServiceIntegration
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **app_type_id** | **Integer** | | [optional]
7
- **app_type_name** | **String** | | [optional]
8
- **display_name** | **String** | | [optional]
9
- **enabled** | **BOOLEAN** | | [optional]
10
- **external_product_id** | **Integer** | | [optional]
11
- **external_product_name** | **String** | | [optional]
12
- **id** | **Integer** | | [optional]
13
- **integration_type** | **String** | | [optional]
14
- **ordinal** | **Integer** | | [optional]
15
- **parent_integration_id** | **Integer** | | [optional]
16
- **sematext_service** | **String** | | [optional]
17
- **visible** | **BOOLEAN** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | ------------------------- | ----------- | ----------- | ---------- |
6
+ | **app_type_id** | **Integer** | | [optional] |
7
+ | **app_type_name** | **String** | | [optional] |
8
+ | **display_name** | **String** | | [optional] |
9
+ | **enabled** | **BOOLEAN** | | [optional] |
10
+ | **external_product_id** | **Integer** | | [optional] |
11
+ | **external_product_name** | **String** | | [optional] |
12
+ | **id** | **Integer** | | [optional] |
13
+ | **integration_type** | **String** | | [optional] |
14
+ | **ordinal** | **Integer** | | [optional] |
15
+ | **parent_integration_id** | **Integer** | | [optional] |
16
+ | **sematext_service** | **String** | | [optional] |
17
+ | **visible** | **BOOLEAN** | | [optional] |
data/docs/SubscriptionDashboardDto.md ADDED
@@ -0,0 +1,16 @@
1
+ # stcloud::SubscriptionDashboardDto
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ---------------- | ------------ | ----------- | ---------- |
6
+ | **addresses** | **String** | | [optional] |
7
+ | **dashboard_id** | **Integer** | | [optional] |
8
+ | **enable** | **BOOLEAN** | | [optional] |
9
+ | **filters** | **String** | | [optional] |
10
+ | **frequency** | **String** | | [optional] |
11
+ | **id** | **Integer** | | [optional] |
12
+ | **report_name** | **String** | | [optional] |
13
+ | **send_time** | **DateTime** | | [optional] |
14
+ | **subject** | **String** | | [optional] |
15
+ | **text** | **String** | | [optional] |
16
+ | **time_range** | **String** | | [optional] |
data/docs/SubscriptionDto.md ADDED
@@ -0,0 +1,17 @@
1
+ # stcloud::SubscriptionDto
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | -------------------- | ----------------------------------------- | ----------- | ---------- |
6
+ | **addresses** | **String** | | [optional] |
7
+ | **enable** | **BOOLEAN** | | [optional] |
8
+ | **filters** | **String** | | [optional] |
9
+ | **frequency** | **String** | | [optional] |
10
+ | **id** | **Integer** | | [optional] |
11
+ | **report_name** | **String** | | [optional] |
12
+ | **send_time** | **DateTime** | | [optional] |
13
+ | **subject** | **String** | | [optional] |
14
+ | **system_id** | **Integer** | | [optional] |
15
+ | **text** | **String** | | [optional] |
16
+ | **time_range** | **String** | | [optional] |
17
+ | **user_permissions** | [**UserPermissions**](UserPermissions.md) | | [optional] |
data/docs/SubscriptionsApi.md CHANGED
@@ -2,48 +2,166 @@
2
2
 
3
3
  All URIs are relative to *https://localhost*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**list_using_get1**](SubscriptionsApi.md#list_using_get1) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an app
8
- [**send_report_using_post**](SubscriptionsApi.md#send_report_using_post) | **POST** /users-web/api/v3/apps/{appId}/report/send | Trigger emailing of report for an app
5
+ | Method | HTTP request | Description |
6
+ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | --------------------------------------- |
7
+ | [**create_for_app_using_post**](SubscriptionsApi.md#create_for_app_using_post) | **POST** /users-web/api/v3/apps/{appId}/subscription | Create App subscription |
8
+ | [**create_for_dash_using_post1**](SubscriptionsApi.md#create_for_dash_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/subscription | Create dashboard subscription |
9
+ | [**delete_using_delete2**](SubscriptionsApi.md#delete_using_delete2) | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription |
10
+ | [**list_using_get2**](SubscriptionsApi.md#list_using_get2) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an App |
11
+ | [**list_using_get5**](SubscriptionsApi.md#list_using_get5) | **GET** /users-web/api/v3/subscriptions | Get current account's subscriptions |
12
+ | [**send_app_report_using_post1**](SubscriptionsApi.md#send_app_report_using_post1) | **POST** /users-web/api/v3/apps/{appId}/report/send | Email an App report |
13
+ | [**send_dash_report_using_post1**](SubscriptionsApi.md#send_dash_report_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/report/send | Email a dashboard report |
14
+ | [**toggle_enabled_using_put1**](SubscriptionsApi.md#toggle_enabled_using_put1) | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Toggle subscription status |
15
+ | [**update_for_app_using_put1**](SubscriptionsApi.md#update_for_app_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/subscription | Update App subscription |
16
+ | [**update_for_dash_using_put**](SubscriptionsApi.md#update_for_dash_using_put) | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription | Update dashboard subscription |
9
17
 
10
18
 
11
- # **list_using_get1**
12
- > GenericApiResponse list_using_get1(app_id)
19
+ # **create_for_app_using_post**
20
+ > GenericApiResponse create_for_app_using_post(app_id, subscription)
13
21
 
14
- Get subscriptions for an app
22
+ Create App subscription
15
23
 
16
24
  ### Example
17
25
  ```ruby
18
26
  # load the gem
19
- require 'SematextCloud'
27
+ require 'stcloud'
20
28
  # setup authorization
21
- SematextCloud.configure do |config|
29
+ stcloud.configure do |config|
22
30
  # Configure API key authorization: api_key
23
31
  config.api_key['Authorization'] = 'YOUR API KEY'
24
32
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
25
33
  #config.api_key_prefix['Authorization'] = 'Bearer'
26
34
  end
27
35
 
28
- api_instance = SematextCloud::SubscriptionsApi.new
36
+ api_instance = stcloud::SubscriptionsApi.new
29
37
 
30
38
  app_id = 789 # Integer | appId
31
39
 
40
+ subscription = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
41
+
42
+
43
+ begin
44
+ #Create App subscription
45
+ result = api_instance.create_for_app_using_post(app_id, subscription)
46
+ p result
47
+ rescue stcloud::ApiError => e
48
+ puts "Exception when calling SubscriptionsApi->create_for_app_using_post: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ | Name | Type | Description | Notes |
55
+ | ---------------- | ----------------------------------------- | ------------ | ----- |
56
+ | **app_id** | **Integer** | appId |
57
+ | **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
58
+
59
+ ### Return type
60
+
61
+ [**GenericApiResponse**](GenericApiResponse.md)
62
+
63
+ ### Authorization
64
+
65
+ [api_key](../README.md#api_key)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: application/json
70
+ - **Accept**: application/json
71
+
72
+
73
+
74
+ # **create_for_dash_using_post1**
75
+ > GenericApiResponse create_for_dash_using_post1(dash_id, subscription)
76
+
77
+ Create dashboard subscription
78
+
79
+ ### Example
80
+ ```ruby
81
+ # load the gem
82
+ require 'stcloud'
83
+ # setup authorization
84
+ stcloud.configure do |config|
85
+ # Configure API key authorization: api_key
86
+ config.api_key['Authorization'] = 'YOUR API KEY'
87
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
88
+ #config.api_key_prefix['Authorization'] = 'Bearer'
89
+ end
90
+
91
+ api_instance = stcloud::SubscriptionsApi.new
92
+
93
+ dash_id = 789 # Integer | dashId
94
+
95
+ subscription = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
96
+
97
+
98
+ begin
99
+ #Create dashboard subscription
100
+ result = api_instance.create_for_dash_using_post1(dash_id, subscription)
101
+ p result
102
+ rescue stcloud::ApiError => e
103
+ puts "Exception when calling SubscriptionsApi->create_for_dash_using_post1: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ | Name | Type | Description | Notes |
110
+ | ---------------- | ----------------------------------------------------------- | ------------ | ----- |
111
+ | **dash_id** | **Integer** | dashId |
112
+ | **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
113
+
114
+ ### Return type
115
+
116
+ [**GenericApiResponse**](GenericApiResponse.md)
117
+
118
+ ### Authorization
119
+
120
+ [api_key](../README.md#api_key)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: application/json
125
+ - **Accept**: application/json
126
+
127
+
128
+
129
+ # **delete_using_delete2**
130
+ > GenericApiResponse delete_using_delete2(updateable_subscription_id)
131
+
132
+ Delete subscription
133
+
134
+ ### Example
135
+ ```ruby
136
+ # load the gem
137
+ require 'stcloud'
138
+ # setup authorization
139
+ stcloud.configure do |config|
140
+ # Configure API key authorization: api_key
141
+ config.api_key['Authorization'] = 'YOUR API KEY'
142
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
143
+ #config.api_key_prefix['Authorization'] = 'Bearer'
144
+ end
145
+
146
+ api_instance = stcloud::SubscriptionsApi.new
147
+
148
+ updateable_subscription_id = 789 # Integer | updateableSubscriptionId
149
+
32
150
 
33
151
  begin
34
- #Get subscriptions for an app
35
- result = api_instance.list_using_get1(app_id)
152
+ #Delete subscription
153
+ result = api_instance.delete_using_delete2(updateable_subscription_id)
36
154
  p result
37
- rescue SematextCloud::ApiError => e
38
- puts "Exception when calling SubscriptionsApi->list_using_get1: #{e}"
155
+ rescue stcloud::ApiError => e
156
+ puts "Exception when calling SubscriptionsApi->delete_using_delete2: #{e}"
39
157
  end
40
158
  ```
41
159
 
42
160
  ### Parameters
43
161
 
44
- Name | Type | Description | Notes
45
- ------------- | ------------- | ------------- | -------------
46
- **app_id** | **Integer**| appId |
162
+ | Name | Type | Description | Notes |
163
+ | ------------------------------ | ----------- | ------------------------ | ----- |
164
+ | **updateable_subscription_id** | **Integer** | updateableSubscriptionId |
47
165
 
48
166
  ### Return type
49
167
 
@@ -60,45 +178,363 @@ Name | Type | Description | Notes
60
178
 
61
179
 
62
180
 
63
- # **send_report_using_post**
64
- > GenericApiResponse send_report_using_post(app_id, email_dto)
181
+ # **list_using_get2**
182
+ > GenericApiResponse list_using_get2(app_id)
65
183
 
66
- Trigger emailing of report for an app
184
+ Get subscriptions for an App
67
185
 
68
186
  ### Example
69
187
  ```ruby
70
188
  # load the gem
71
- require 'SematextCloud'
189
+ require 'stcloud'
72
190
  # setup authorization
73
- SematextCloud.configure do |config|
191
+ stcloud.configure do |config|
74
192
  # Configure API key authorization: api_key
75
193
  config.api_key['Authorization'] = 'YOUR API KEY'
76
194
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
77
195
  #config.api_key_prefix['Authorization'] = 'Bearer'
78
196
  end
79
197
 
80
- api_instance = SematextCloud::SubscriptionsApi.new
198
+ api_instance = stcloud::SubscriptionsApi.new
81
199
 
82
200
  app_id = 789 # Integer | appId
83
201
 
84
- email_dto = SematextCloud::ReportInfo.new # ReportInfo | emailDto
202
+
203
+ begin
204
+ #Get subscriptions for an App
205
+ result = api_instance.list_using_get2(app_id)
206
+ p result
207
+ rescue stcloud::ApiError => e
208
+ puts "Exception when calling SubscriptionsApi->list_using_get2: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---------- | ----------- | ----------- | ----- |
216
+ | **app_id** | **Integer** | appId |
217
+
218
+ ### Return type
219
+
220
+ [**GenericApiResponse**](GenericApiResponse.md)
221
+
222
+ ### Authorization
223
+
224
+ [api_key](../README.md#api_key)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: application/json
229
+ - **Accept**: application/json
230
+
231
+
232
+
233
+ # **list_using_get5**
234
+ > GenericApiResponse list_using_get5
235
+
236
+ Get current account's subscriptions
237
+
238
+ ### Example
239
+ ```ruby
240
+ # load the gem
241
+ require 'stcloud'
242
+ # setup authorization
243
+ stcloud.configure do |config|
244
+ # Configure API key authorization: api_key
245
+ config.api_key['Authorization'] = 'YOUR API KEY'
246
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
247
+ #config.api_key_prefix['Authorization'] = 'Bearer'
248
+ end
249
+
250
+ api_instance = stcloud::SubscriptionsApi.new
251
+
252
+ begin
253
+ #Get current account's subscriptions
254
+ result = api_instance.list_using_get5
255
+ p result
256
+ rescue stcloud::ApiError => e
257
+ puts "Exception when calling SubscriptionsApi->list_using_get5: #{e}"
258
+ end
259
+ ```
260
+
261
+ ### Parameters
262
+ This endpoint does not need any parameter.
263
+
264
+ ### Return type
265
+
266
+ [**GenericApiResponse**](GenericApiResponse.md)
267
+
268
+ ### Authorization
269
+
270
+ [api_key](../README.md#api_key)
271
+
272
+ ### HTTP request headers
273
+
274
+ - **Content-Type**: application/json
275
+ - **Accept**: application/json
276
+
277
+
278
+
279
+ # **send_app_report_using_post1**
280
+ > GenericApiResponse send_app_report_using_post1(app_id, email_dto)
281
+
282
+ Email an App report
283
+
284
+ ### Example
285
+ ```ruby
286
+ # load the gem
287
+ require 'stcloud'
288
+ # setup authorization
289
+ stcloud.configure do |config|
290
+ # Configure API key authorization: api_key
291
+ config.api_key['Authorization'] = 'YOUR API KEY'
292
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
293
+ #config.api_key_prefix['Authorization'] = 'Bearer'
294
+ end
295
+
296
+ api_instance = stcloud::SubscriptionsApi.new
297
+
298
+ app_id = 789 # Integer | appId
299
+
300
+ email_dto = stcloud::ReportInfo.new # ReportInfo | emailDto
301
+
302
+
303
+ begin
304
+ #Email an App report
305
+ result = api_instance.send_app_report_using_post1(app_id, email_dto)
306
+ p result
307
+ rescue stcloud::ApiError => e
308
+ puts "Exception when calling SubscriptionsApi->send_app_report_using_post1: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ | Name | Type | Description | Notes |
315
+ | ------------- | ------------------------------- | ----------- | ----- |
316
+ | **app_id** | **Integer** | appId |
317
+ | **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto |
318
+
319
+ ### Return type
320
+
321
+ [**GenericApiResponse**](GenericApiResponse.md)
322
+
323
+ ### Authorization
324
+
325
+ [api_key](../README.md#api_key)
326
+
327
+ ### HTTP request headers
328
+
329
+ - **Content-Type**: application/json
330
+ - **Accept**: application/json
331
+
332
+
333
+
334
+ # **send_dash_report_using_post1**
335
+ > GenericApiResponse send_dash_report_using_post1(dash_id, email_dto)
336
+
337
+ Email a dashboard report
338
+
339
+ ### Example
340
+ ```ruby
341
+ # load the gem
342
+ require 'stcloud'
343
+ # setup authorization
344
+ stcloud.configure do |config|
345
+ # Configure API key authorization: api_key
346
+ config.api_key['Authorization'] = 'YOUR API KEY'
347
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
348
+ #config.api_key_prefix['Authorization'] = 'Bearer'
349
+ end
350
+
351
+ api_instance = stcloud::SubscriptionsApi.new
352
+
353
+ dash_id = 789 # Integer | dashId
354
+
355
+ email_dto = stcloud::ReportInfo.new # ReportInfo | emailDto
356
+
357
+
358
+ begin
359
+ #Email a dashboard report
360
+ result = api_instance.send_dash_report_using_post1(dash_id, email_dto)
361
+ p result
362
+ rescue stcloud::ApiError => e
363
+ puts "Exception when calling SubscriptionsApi->send_dash_report_using_post1: #{e}"
364
+ end
365
+ ```
366
+
367
+ ### Parameters
368
+
369
+ | Name | Type | Description | Notes |
370
+ | ------------- | ------------------------------- | ----------- | ----- |
371
+ | **dash_id** | **Integer** | dashId |
372
+ | **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto |
373
+
374
+ ### Return type
375
+
376
+ [**GenericApiResponse**](GenericApiResponse.md)
377
+
378
+ ### Authorization
379
+
380
+ [api_key](../README.md#api_key)
381
+
382
+ ### HTTP request headers
383
+
384
+ - **Content-Type**: application/json
385
+ - **Accept**: application/json
386
+
387
+
388
+
389
+ # **toggle_enabled_using_put1**
390
+ > GenericApiResponse toggle_enabled_using_put1(updateable_subscription_id, dto)
391
+
392
+ Toggle subscription status
393
+
394
+ ### Example
395
+ ```ruby
396
+ # load the gem
397
+ require 'stcloud'
398
+ # setup authorization
399
+ stcloud.configure do |config|
400
+ # Configure API key authorization: api_key
401
+ config.api_key['Authorization'] = 'YOUR API KEY'
402
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
+ #config.api_key_prefix['Authorization'] = 'Bearer'
404
+ end
405
+
406
+ api_instance = stcloud::SubscriptionsApi.new
407
+
408
+ updateable_subscription_id = 789 # Integer | updateableSubscriptionId
409
+
410
+ dto = stcloud::UpdateSubscriptionDto.new # UpdateSubscriptionDto | dto
411
+
412
+
413
+ begin
414
+ #Toggle subscription status
415
+ result = api_instance.toggle_enabled_using_put1(updateable_subscription_id, dto)
416
+ p result
417
+ rescue stcloud::ApiError => e
418
+ puts "Exception when calling SubscriptionsApi->toggle_enabled_using_put1: #{e}"
419
+ end
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+ | Name | Type | Description | Notes |
425
+ | ------------------------------ | ----------------------------------------------------- | ------------------------ | ----- |
426
+ | **updateable_subscription_id** | **Integer** | updateableSubscriptionId |
427
+ | **dto** | [**UpdateSubscriptionDto**](UpdateSubscriptionDto.md) | dto |
428
+
429
+ ### Return type
430
+
431
+ [**GenericApiResponse**](GenericApiResponse.md)
432
+
433
+ ### Authorization
434
+
435
+ [api_key](../README.md#api_key)
436
+
437
+ ### HTTP request headers
438
+
439
+ - **Content-Type**: application/json
440
+ - **Accept**: application/json
441
+
442
+
443
+
444
+ # **update_for_app_using_put1**
445
+ > GenericApiResponse update_for_app_using_put1(app_id, subscription)
446
+
447
+ Update App subscription
448
+
449
+ ### Example
450
+ ```ruby
451
+ # load the gem
452
+ require 'stcloud'
453
+ # setup authorization
454
+ stcloud.configure do |config|
455
+ # Configure API key authorization: api_key
456
+ config.api_key['Authorization'] = 'YOUR API KEY'
457
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
458
+ #config.api_key_prefix['Authorization'] = 'Bearer'
459
+ end
460
+
461
+ api_instance = stcloud::SubscriptionsApi.new
462
+
463
+ app_id = 789 # Integer | appId
464
+
465
+ subscription = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
466
+
467
+
468
+ begin
469
+ #Update App subscription
470
+ result = api_instance.update_for_app_using_put1(app_id, subscription)
471
+ p result
472
+ rescue stcloud::ApiError => e
473
+ puts "Exception when calling SubscriptionsApi->update_for_app_using_put1: #{e}"
474
+ end
475
+ ```
476
+
477
+ ### Parameters
478
+
479
+ | Name | Type | Description | Notes |
480
+ | ---------------- | ----------------------------------------- | ------------ | ----- |
481
+ | **app_id** | **Integer** | appId |
482
+ | **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
483
+
484
+ ### Return type
485
+
486
+ [**GenericApiResponse**](GenericApiResponse.md)
487
+
488
+ ### Authorization
489
+
490
+ [api_key](../README.md#api_key)
491
+
492
+ ### HTTP request headers
493
+
494
+ - **Content-Type**: application/json
495
+ - **Accept**: application/json
496
+
497
+
498
+
499
+ # **update_for_dash_using_put**
500
+ > GenericApiResponse update_for_dash_using_put(dash_id, subscription)
501
+
502
+ Update dashboard subscription
503
+
504
+ ### Example
505
+ ```ruby
506
+ # load the gem
507
+ require 'stcloud'
508
+ # setup authorization
509
+ stcloud.configure do |config|
510
+ # Configure API key authorization: api_key
511
+ config.api_key['Authorization'] = 'YOUR API KEY'
512
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
513
+ #config.api_key_prefix['Authorization'] = 'Bearer'
514
+ end
515
+
516
+ api_instance = stcloud::SubscriptionsApi.new
517
+
518
+ dash_id = 789 # Integer | dashId
519
+
520
+ subscription = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
85
521
 
86
522
 
87
523
  begin
88
- #Trigger emailing of report for an app
89
- result = api_instance.send_report_using_post(app_id, email_dto)
524
+ #Update dashboard subscription
525
+ result = api_instance.update_for_dash_using_put(dash_id, subscription)
90
526
  p result
91
- rescue SematextCloud::ApiError => e
92
- puts "Exception when calling SubscriptionsApi->send_report_using_post: #{e}"
527
+ rescue stcloud::ApiError => e
528
+ puts "Exception when calling SubscriptionsApi->update_for_dash_using_put: #{e}"
93
529
  end
94
530
  ```
95
531
 
96
532
  ### Parameters
97
533
 
98
- Name | Type | Description | Notes
99
- ------------- | ------------- | ------------- | -------------
100
- **app_id** | **Integer**| appId |
101
- **email_dto** | [**ReportInfo**](ReportInfo.md)| emailDto |
534
+ | Name | Type | Description | Notes |
535
+ | ---------------- | ----------------------------------------------------------- | ------------ | ----- |
536
+ | **dash_id** | **Integer** | dashId |
537
+ | **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
102
538
 
103
539
  ### Return type
104
540