SematextCloud 0.1.2 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (299) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/README.md +80 -69
  4. data/SematextCloud.gemspec +0 -6
  5. data/docs/AlertNotification.md +12 -0
  6. data/docs/AlertNotificationRequest.md +7 -7
  7. data/docs/AlertNotificationsApi.md +33 -37
  8. data/docs/AlertRule.md +51 -51
  9. data/docs/AlertRuleResponse.md +9 -0
  10. data/docs/AlertRuleResponseEntry.md +6 -0
  11. data/docs/AlertRuleScheduleTimeRangeDto.md +5 -5
  12. data/docs/AlertRuleScheduleWeekdayDto.md +8 -8
  13. data/docs/AlertRulesResponse.md +9 -0
  14. data/docs/AlertRulesResponseEntry.md +6 -0
  15. data/docs/AlertsApi.md +60 -66
  16. data/docs/App.md +35 -30
  17. data/docs/AppDescription.md +4 -4
  18. data/docs/AppMetadata.md +8 -8
  19. data/docs/AppResponse.md +9 -0
  20. data/docs/AppResponseEntry.md +6 -0
  21. data/docs/AppTypesResponse.md +9 -0
  22. data/docs/AppTypesResponseEntry.md +6 -0
  23. data/docs/AppsApi.md +135 -90
  24. data/docs/AppsResponse.md +9 -0
  25. data/docs/AppsResponseEntry.md +6 -0
  26. data/docs/AwsSettingsControllerApi.md +19 -22
  27. data/docs/BasicAuthMethodDto.md +5 -5
  28. data/docs/BasicOrganizationDto.md +7 -7
  29. data/docs/BillingApi.md +47 -54
  30. data/docs/BillingInfo.md +6 -6
  31. data/docs/ChargesDetailsResponseDto.md +12 -0
  32. data/docs/CloudWatchSettings.md +7 -7
  33. data/docs/CloudWatchSettingsResponse.md +9 -0
  34. data/docs/CloudWatchSettingsResponseEntry.md +6 -0
  35. data/docs/CreateAppInfo.md +8 -8
  36. data/docs/CreateTokenDto.md +8 -0
  37. data/docs/DailyDto.md +9 -0
  38. data/docs/DataSeriesFilter.md +5 -5
  39. data/docs/DataSeriesRequest.md +9 -9
  40. data/docs/DayUsageData.md +26 -0
  41. data/docs/Dimension.md +7 -0
  42. data/docs/Error.md +5 -5
  43. data/docs/EventDto.md +8 -0
  44. data/docs/FilterValue.md +9 -9
  45. data/docs/GenericApiResponse.md +7 -7
  46. data/docs/GenericMapBasedApiResponse.md +9 -0
  47. data/docs/Invitation.md +13 -13
  48. data/docs/Invoice.md +11 -0
  49. data/docs/InvoiceResponse.md +9 -0
  50. data/docs/InvoiceResponseEntry.md +6 -0
  51. data/docs/LimitChangeEventDTO.md +8 -0
  52. data/docs/LogsAppApi.md +16 -18
  53. data/docs/LogsUsageApiControllerApi.md +60 -0
  54. data/docs/MailReportResponse.md +9 -0
  55. data/docs/MailReportResponseResponseEntry.md +6 -0
  56. data/docs/MetricsApi.md +20 -20
  57. data/docs/MinPeriodFeePeriod.md +16 -0
  58. data/docs/MonitoringAppApi.md +16 -18
  59. data/docs/NotificationIntegration.md +13 -13
  60. data/docs/NotificationsResponse.md +9 -0
  61. data/docs/NotificationsResponseEntry.md +8 -0
  62. data/docs/Plan.md +16 -16
  63. data/docs/PlansResponse.md +9 -0
  64. data/docs/PlansResponseEntry.md +6 -0
  65. data/docs/ReportInfo.md +11 -11
  66. data/docs/ResetPasswordApi.md +16 -18
  67. data/docs/SavedQueriesApi.md +19 -19
  68. data/docs/SavedQuery.md +15 -15
  69. data/docs/ServiceIntegration.md +15 -15
  70. data/docs/Subscription.md +20 -0
  71. data/docs/SubscriptionDashboardDto.md +16 -0
  72. data/docs/SubscriptionDto.md +17 -0
  73. data/docs/SubscriptionResponse.md +9 -0
  74. data/docs/SubscriptionResponseEntry.md +6 -0
  75. data/docs/SubscriptionsApi.md +455 -36
  76. data/docs/SubscriptionsResponse.md +9 -0
  77. data/docs/SubscriptionsResponseEntry.md +6 -0
  78. data/docs/TagApiControllerApi.md +63 -72
  79. data/docs/TagNamesResponse.md +6 -0
  80. data/docs/TokenDto.md +12 -0
  81. data/docs/TokenResponse.md +9 -0
  82. data/docs/TokenResponseEntry.md +6 -0
  83. data/docs/TokensApiControllerApi.md +274 -0
  84. data/docs/TokensResponse.md +9 -0
  85. data/docs/TokensResponseEntry.md +6 -0
  86. data/docs/UpdateAppInfo.md +12 -12
  87. data/docs/UpdatePlanResponse.md +9 -0
  88. data/docs/UpdatePlanResponseDto.md +7 -0
  89. data/docs/UpdatePlanResponseEntry.md +6 -0
  90. data/docs/UpdateSubscriptionDto.md +6 -0
  91. data/docs/UpdateTokenDto.md +7 -0
  92. data/docs/UsageDto.md +16 -0
  93. data/docs/UsageMultiResponse.md +9 -0
  94. data/docs/UsageMultiResponseEntry.md +6 -0
  95. data/docs/UsageResponse.md +9 -0
  96. data/docs/UsageResponseEntry.md +6 -0
  97. data/docs/UserInfo.md +4 -4
  98. data/docs/UserPermissions.md +6 -6
  99. data/docs/UserRole.md +6 -6
  100. data/lib/SematextCloud/api/apps_api.rb +52 -0
  101. data/lib/SematextCloud/api/subscriptions_api.rb +463 -17
  102. data/lib/SematextCloud/api/tokens_api_controller_api.rb +313 -0
  103. data/lib/SematextCloud/models/create_token_dto.rb +201 -0
  104. data/lib/SematextCloud/models/subscription_dashboard_dto.rb +319 -0
  105. data/lib/SematextCloud/models/subscription_dto.rb +328 -0
  106. data/lib/SematextCloud/models/update_subscription_dto.rb +183 -0
  107. data/lib/SematextCloud/models/update_token_dto.rb +192 -0
  108. data/lib/SematextCloud/version.rb +1 -1
  109. data/lib/stcloud.rb +128 -0
  110. data/lib/stcloud/api/alert_notifications_api.rb +142 -0
  111. data/lib/stcloud/api/alerts_api.rb +292 -0
  112. data/lib/stcloud/api/apps_api.rb +452 -0
  113. data/lib/stcloud/api/aws_settings_controller_api.rb +84 -0
  114. data/lib/stcloud/api/billing_api.rb +202 -0
  115. data/lib/stcloud/api/logs_app_api.rb +76 -0
  116. data/lib/stcloud/api/logs_usage_api_controller_api.rb +86 -0
  117. data/lib/stcloud/api/monitoring_app_api.rb +76 -0
  118. data/lib/stcloud/api/reset_password_api.rb +76 -0
  119. data/lib/stcloud/api/subscriptions_api.rb +610 -0
  120. data/lib/stcloud/api/tag_api_controller_api.rb +250 -0
  121. data/lib/stcloud/api/tokens_api_controller_api.rb +324 -0
  122. data/lib/stcloud/api_client.rb +388 -0
  123. data/lib/stcloud/api_error.rb +57 -0
  124. data/lib/stcloud/configuration.rb +205 -0
  125. data/lib/stcloud/models/alert_notification.rb +260 -0
  126. data/lib/stcloud/models/alert_notification_request.rb +235 -0
  127. data/lib/stcloud/models/alert_rule.rb +675 -0
  128. data/lib/stcloud/models/alert_rule_response.rb +235 -0
  129. data/lib/stcloud/models/alert_rule_response_entry.rb +206 -0
  130. data/lib/stcloud/models/alert_rule_schedule_time_range_dto.rb +215 -0
  131. data/lib/stcloud/models/alert_rule_schedule_weekday_dto.rb +244 -0
  132. data/lib/stcloud/models/alert_rules_response.rb +235 -0
  133. data/lib/stcloud/models/alert_rules_response_entry.rb +208 -0
  134. data/lib/stcloud/models/app.rb +489 -0
  135. data/lib/stcloud/models/app_description.rb +206 -0
  136. data/lib/stcloud/models/app_metadata.rb +291 -0
  137. data/lib/stcloud/models/app_response.rb +235 -0
  138. data/lib/stcloud/models/app_response_entry.rb +206 -0
  139. data/lib/stcloud/models/app_types_response.rb +235 -0
  140. data/lib/stcloud/models/app_types_response_entry.rb +208 -0
  141. data/lib/stcloud/models/apps_response.rb +235 -0
  142. data/lib/stcloud/models/apps_response_entry.rb +208 -0
  143. data/lib/stcloud/models/basic_auth_method_dto.rb +249 -0
  144. data/lib/stcloud/models/basic_organization_dto.rb +269 -0
  145. data/lib/stcloud/models/billing_info.rb +224 -0
  146. data/lib/stcloud/models/charges_details_response_dto.rb +298 -0
  147. data/lib/stcloud/models/cloud_watch_settings.rb +279 -0
  148. data/lib/stcloud/models/cloud_watch_settings_response.rb +235 -0
  149. data/lib/stcloud/models/cloud_watch_settings_response_entry.rb +206 -0
  150. data/lib/stcloud/models/create_app_info.rb +242 -0
  151. data/lib/stcloud/models/create_token_dto.rb +224 -0
  152. data/lib/stcloud/models/daily_dto.rb +233 -0
  153. data/lib/stcloud/models/day_usage_data.rb +411 -0
  154. data/lib/stcloud/models/dimension.rb +227 -0
  155. data/lib/stcloud/models/error.rb +215 -0
  156. data/lib/stcloud/models/event_dto.rb +258 -0
  157. data/lib/stcloud/models/filter_value.rb +253 -0
  158. data/lib/stcloud/models/generic_api_response.rb +236 -0
  159. data/lib/stcloud/models/generic_map_based_api_response.rb +236 -0
  160. data/lib/stcloud/models/invitation.rb +348 -0
  161. data/lib/stcloud/models/invoice.rb +253 -0
  162. data/lib/stcloud/models/invoice_response.rb +235 -0
  163. data/lib/stcloud/models/invoice_response_entry.rb +206 -0
  164. data/lib/stcloud/models/limit_change_event_dto.rb +224 -0
  165. data/lib/stcloud/models/mail_report_response.rb +235 -0
  166. data/lib/stcloud/models/mail_report_response_response_entry.rb +206 -0
  167. data/lib/stcloud/models/min_period_fee_period.rb +296 -0
  168. data/lib/stcloud/models/notification_integration.rb +347 -0
  169. data/lib/stcloud/models/notifications_response.rb +235 -0
  170. data/lib/stcloud/models/notifications_response_entry.rb +226 -0
  171. data/lib/stcloud/models/plan.rb +360 -0
  172. data/lib/stcloud/models/plans_response.rb +235 -0
  173. data/lib/stcloud/models/plans_response_entry.rb +208 -0
  174. data/lib/stcloud/models/report_info.rb +270 -0
  175. data/lib/stcloud/models/service_integration.rb +305 -0
  176. data/lib/stcloud/models/subscription.rb +378 -0
  177. data/lib/stcloud/models/subscription_dashboard_dto.rb +342 -0
  178. data/lib/stcloud/models/subscription_dto.rb +351 -0
  179. data/lib/stcloud/models/subscription_response.rb +235 -0
  180. data/lib/stcloud/models/subscription_response_entry.rb +206 -0
  181. data/lib/stcloud/models/subscriptions_response.rb +235 -0
  182. data/lib/stcloud/models/subscriptions_response_entry.rb +208 -0
  183. data/lib/stcloud/models/tag_names_response.rb +213 -0
  184. data/lib/stcloud/models/token_dto.rb +260 -0
  185. data/lib/stcloud/models/token_response.rb +235 -0
  186. data/lib/stcloud/models/token_response_entry.rb +206 -0
  187. data/lib/stcloud/models/tokens_response.rb +235 -0
  188. data/lib/stcloud/models/tokens_response_entry.rb +208 -0
  189. data/lib/stcloud/models/update_app_info.rb +312 -0
  190. data/lib/stcloud/models/update_plan_response.rb +235 -0
  191. data/lib/stcloud/models/update_plan_response_dto.rb +217 -0
  192. data/lib/stcloud/models/update_plan_response_entry.rb +206 -0
  193. data/lib/stcloud/models/update_subscription_dto.rb +206 -0
  194. data/lib/stcloud/models/update_token_dto.rb +215 -0
  195. data/lib/stcloud/models/usage_dto.rb +302 -0
  196. data/lib/stcloud/models/usage_multi_response.rb +235 -0
  197. data/lib/stcloud/models/usage_multi_response_entry.rb +206 -0
  198. data/lib/stcloud/models/usage_response.rb +235 -0
  199. data/lib/stcloud/models/usage_response_entry.rb +206 -0
  200. data/lib/stcloud/models/user_info.rb +206 -0
  201. data/lib/stcloud/models/user_permissions.rb +224 -0
  202. data/lib/stcloud/models/user_role.rb +270 -0
  203. data/lib/stcloud/version.rb +14 -0
  204. data/spec/api/alert_notifications_api_spec.rb +12 -13
  205. data/spec/api/alerts_api_spec.rb +10 -11
  206. data/spec/api/apps_api_spec.rb +31 -21
  207. data/spec/api/aws_settings_controller_api_spec.rb +9 -10
  208. data/spec/api/billing_api_spec.rb +12 -13
  209. data/spec/api/logs_app_api_spec.rb +6 -7
  210. data/spec/api/logs_usage_api_controller_api_spec.rb +47 -0
  211. data/spec/api/monitoring_app_api_spec.rb +6 -7
  212. data/spec/api/reset_password_api_spec.rb +6 -7
  213. data/spec/api/subscriptions_api_spec.rb +106 -14
  214. data/spec/api/tag_api_controller_api_spec.rb +11 -12
  215. data/spec/api/tokens_api_controller_api_spec.rb +94 -0
  216. data/spec/api_client_spec.rb +30 -31
  217. data/spec/base_object_spec.rb +109 -0
  218. data/spec/configuration_spec.rb +7 -8
  219. data/spec/models/alert_notification_request_spec.rb +1 -2
  220. data/spec/models/alert_notification_spec.rb +76 -0
  221. data/spec/models/alert_rule_response_entry_spec.rb +40 -0
  222. data/spec/models/alert_rule_response_spec.rb +58 -0
  223. data/spec/models/alert_rule_schedule_time_range_dto_spec.rb +1 -2
  224. data/spec/models/alert_rule_schedule_weekday_dto_spec.rb +1 -2
  225. data/spec/models/alert_rule_spec.rb +1 -2
  226. data/spec/models/alert_rules_response_entry_spec.rb +40 -0
  227. data/spec/models/alert_rules_response_spec.rb +58 -0
  228. data/spec/models/app_description_spec.rb +1 -2
  229. data/spec/models/app_metadata_spec.rb +1 -2
  230. data/spec/models/app_response_entry_spec.rb +40 -0
  231. data/spec/models/app_response_spec.rb +58 -0
  232. data/spec/models/app_spec.rb +31 -2
  233. data/spec/models/app_types_response_entry_spec.rb +40 -0
  234. data/spec/models/app_types_response_spec.rb +58 -0
  235. data/spec/models/apps_response_entry_spec.rb +40 -0
  236. data/spec/models/apps_response_spec.rb +58 -0
  237. data/spec/models/basic_auth_method_dto_spec.rb +1 -2
  238. data/spec/models/basic_organization_dto_spec.rb +1 -2
  239. data/spec/models/billing_info_spec.rb +1 -2
  240. data/spec/models/charges_details_response_dto_spec.rb +80 -0
  241. data/spec/models/cloud_watch_settings_response_entry_spec.rb +40 -0
  242. data/spec/models/cloud_watch_settings_response_spec.rb +58 -0
  243. data/spec/models/cloud_watch_settings_spec.rb +1 -2
  244. data/spec/models/create_app_info_spec.rb +1 -2
  245. data/spec/models/create_token_dto_spec.rb +52 -0
  246. data/spec/models/daily_dto_spec.rb +58 -0
  247. data/spec/models/day_usage_data_spec.rb +158 -0
  248. data/spec/models/dimension_spec.rb +46 -0
  249. data/spec/models/error_spec.rb +1 -2
  250. data/spec/models/event_dto_spec.rb +56 -0
  251. data/spec/models/filter_value_spec.rb +1 -2
  252. data/spec/models/generic_api_response_spec.rb +1 -2
  253. data/spec/models/generic_map_based_api_response_spec.rb +58 -0
  254. data/spec/models/invitation_spec.rb +1 -2
  255. data/spec/models/invoice_response_entry_spec.rb +40 -0
  256. data/spec/models/invoice_response_spec.rb +58 -0
  257. data/spec/models/invoice_spec.rb +70 -0
  258. data/spec/models/limit_change_event_dto_spec.rb +52 -0
  259. data/spec/models/mail_report_response_response_entry_spec.rb +40 -0
  260. data/spec/models/mail_report_response_spec.rb +58 -0
  261. data/spec/models/min_period_fee_period_spec.rb +100 -0
  262. data/spec/models/notification_integration_spec.rb +1 -2
  263. data/spec/models/notifications_response_entry_spec.rb +52 -0
  264. data/spec/models/notifications_response_spec.rb +58 -0
  265. data/spec/models/plan_spec.rb +2 -3
  266. data/spec/models/plans_response_entry_spec.rb +40 -0
  267. data/spec/models/plans_response_spec.rb +58 -0
  268. data/spec/models/report_info_spec.rb +1 -2
  269. data/spec/models/service_integration_spec.rb +1 -2
  270. data/spec/models/subscription_dashboard_dto_spec.rb +108 -0
  271. data/spec/models/subscription_dto_spec.rb +114 -0
  272. data/spec/models/subscription_response_entry_spec.rb +40 -0
  273. data/spec/models/subscription_response_spec.rb +58 -0
  274. data/spec/models/subscription_spec.rb +132 -0
  275. data/spec/models/subscriptions_response_entry_spec.rb +40 -0
  276. data/spec/models/subscriptions_response_spec.rb +58 -0
  277. data/spec/models/tag_names_response_spec.rb +40 -0
  278. data/spec/models/token_dto_spec.rb +76 -0
  279. data/spec/models/token_response_entry_spec.rb +40 -0
  280. data/spec/models/token_response_spec.rb +58 -0
  281. data/spec/models/tokens_response_entry_spec.rb +40 -0
  282. data/spec/models/tokens_response_spec.rb +58 -0
  283. data/spec/models/update_app_info_spec.rb +1 -2
  284. data/spec/models/update_plan_response_dto_spec.rb +46 -0
  285. data/spec/models/update_plan_response_entry_spec.rb +40 -0
  286. data/spec/models/update_plan_response_spec.rb +58 -0
  287. data/spec/models/update_subscription_dto_spec.rb +40 -0
  288. data/spec/models/update_token_dto_spec.rb +46 -0
  289. data/spec/models/usage_dto_spec.rb +100 -0
  290. data/spec/models/usage_multi_response_entry_spec.rb +40 -0
  291. data/spec/models/usage_multi_response_spec.rb +58 -0
  292. data/spec/models/usage_response_entry_spec.rb +40 -0
  293. data/spec/models/usage_response_spec.rb +58 -0
  294. data/spec/models/user_info_spec.rb +1 -2
  295. data/spec/models/user_permissions_spec.rb +1 -2
  296. data/spec/models/user_role_spec.rb +1 -2
  297. data/spec/spec_helper.rb +2 -3
  298. metadata +300 -150
  299. data/assets/octi-blue.png +0 -0
@@ -0,0 +1,9 @@
1
+ # stcloud::AlertRuleResponse
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ----------- | ------------------------------------------------------- | ----------- | ---------- |
6
+ | **data** | [**AlertRuleResponseEntry**](AlertRuleResponseEntry.md) | | [optional] |
7
+ | **errors** | [**Array<Error>**](Error.md) | | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+ | **success** | **BOOLEAN** | | [optional] |
@@ -0,0 +1,6 @@
1
+ # stcloud::AlertRuleResponseEntry
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | -------------- | ----------------------------- | ----------- | ---------- |
6
+ | **alert_rule** | [**AlertRule**](AlertRule.md) | | [optional] |
@@ -1,7 +1,7 @@
1
- # SematextCloud::AlertRuleScheduleTimeRangeDto
1
+ # stcloud::AlertRuleScheduleTimeRangeDto
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **_end** | **String** | | [optional]
7
- **start** | **String** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | --------- | ---------- | ----------- | ---------- |
6
+ | **_end** | **String** | | [optional] |
7
+ | **start** | **String** | | [optional] |
@@ -1,10 +1,10 @@
1
- # SematextCloud::AlertRuleScheduleWeekdayDto
1
+ # stcloud::AlertRuleScheduleWeekdayDto
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **day** | **String** | | [optional]
7
- **index** | **Integer** | | [optional]
8
- **intervals** | [**Array<AlertRuleScheduleTimeRangeDto>**](AlertRuleScheduleTimeRangeDto.md) | | [optional]
9
- **label** | **String** | | [optional]
10
- **type** | **String** | | [optional]
4
+ | Name | Type | Description | Notes |
5
+ | ------------- | ---------------------------------------------------------------------------------- | ----------- | ---------- |
6
+ | **day** | **String** | | [optional] |
7
+ | **index** | **Integer** | | [optional] |
8
+ | **intervals** | [**Array<AlertRuleScheduleTimeRangeDto>**](AlertRuleScheduleTimeRangeDto.md) | | [optional] |
9
+ | **label** | **String** | | [optional] |
10
+ | **type** | **String** | | [optional] |
@@ -0,0 +1,9 @@
1
+ # stcloud::AlertRulesResponse
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ----------- | --------------------------------------------------------- | ----------- | ---------- |
6
+ | **data** | [**AlertRulesResponseEntry**](AlertRulesResponseEntry.md) | | [optional] |
7
+ | **errors** | [**Array<Error>**](Error.md) | | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+ | **success** | **BOOLEAN** | | [optional] |
@@ -0,0 +1,6 @@
1
+ # stcloud::AlertRulesResponseEntry
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | --------------- | ------------------------------------------ | ----------- | ---------- |
6
+ | **alert_rules** | [**Array<AlertRule>**](AlertRule.md) | | [optional] |
data/docs/AlertsApi.md CHANGED
@@ -1,56 +1,54 @@
1
- # SematextCloud::AlertsApi
1
+ # stcloud::AlertsApi
2
2
 
3
- All URIs are relative to *https://localhost*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_alert_using_post**](AlertsApi.md#create_alert_using_post) | **POST** /users-web/api/v3/alerts | Create alert rule
8
- [**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete) | **DELETE** /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule
9
- [**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule
10
- [**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule
11
- [**get_alert_rules_for_app_using_get**](AlertsApi.md#get_alert_rules_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/alerts | Get alert rules for an app
3
+ All URIs are relative to */*
12
4
 
5
+ | Method | HTTP request | Description |
6
+ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------------------------- |
7
+ | [**create_alert_using_post**](AlertsApi.md#create_alert_using_post) | **POST** /users-web/api/v3/alerts | Create alert rule |
8
+ | [**delete_alert_rule_using_delete**](AlertsApi.md#delete_alert_rule_using_delete) | **DELETE** /users-web/api/v3/alerts/{updateableAlertId} | Delete alert rule |
9
+ | [**disable_alert_rule_using_put**](AlertsApi.md#disable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/disable | Disable alert rule |
10
+ | [**enable_alert_rule_using_put**](AlertsApi.md#enable_alert_rule_using_put) | **PUT** /users-web/api/v3/alerts/{updateableAlertId}/enable | Enable alert rule |
11
+ | [**get_alert_rules_for_app_using_get**](AlertsApi.md#get_alert_rules_for_app_using_get) | **GET** /users-web/api/v3/apps/{appId}/alerts | Get alert rules for an app |
13
12
 
14
13
  # **create_alert_using_post**
15
- > GenericApiResponse create_alert_using_post(dto)
14
+ > AlertRuleResponse create_alert_using_post(body)
16
15
 
17
16
  Create alert rule
18
17
 
19
18
  ### Example
20
19
  ```ruby
21
20
  # load the gem
22
- require 'SematextCloud'
21
+ require 'stcloud'
23
22
  # setup authorization
24
- SematextCloud.configure do |config|
23
+ stcloud.configure do |config|
25
24
  # Configure API key authorization: api_key
26
25
  config.api_key['Authorization'] = 'YOUR API KEY'
27
26
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
27
  #config.api_key_prefix['Authorization'] = 'Bearer'
29
28
  end
30
29
 
31
- api_instance = SematextCloud::AlertsApi.new
32
-
33
- dto = SematextCloud::AlertRule.new # AlertRule | dto
30
+ api_instance = stcloud::AlertsApi.new
31
+ body = stcloud::AlertRule.new # AlertRule | dto
34
32
 
35
33
 
36
34
  begin
37
35
  #Create alert rule
38
- result = api_instance.create_alert_using_post(dto)
36
+ result = api_instance.create_alert_using_post(body)
39
37
  p result
40
- rescue SematextCloud::ApiError => e
38
+ rescue stcloud::ApiError => e
41
39
  puts "Exception when calling AlertsApi->create_alert_using_post: #{e}"
42
40
  end
43
41
  ```
44
42
 
45
43
  ### Parameters
46
44
 
47
- Name | Type | Description | Notes
48
- ------------- | ------------- | ------------- | -------------
49
- **dto** | [**AlertRule**](AlertRule.md)| dto |
45
+ | Name | Type | Description | Notes |
46
+ | -------- | ----------------------------- | ----------- | ----- |
47
+ | **body** | [**AlertRule**](AlertRule.md) | dto |
50
48
 
51
49
  ### Return type
52
50
 
53
- [**GenericApiResponse**](GenericApiResponse.md)
51
+ [**AlertRuleResponse**](AlertRuleResponse.md)
54
52
 
55
53
  ### Authorization
56
54
 
@@ -64,24 +62,23 @@ Name | Type | Description | Notes
64
62
 
65
63
 
66
64
  # **delete_alert_rule_using_delete**
67
- > GenericApiResponse delete_alert_rule_using_delete(updateable_alert_id)
65
+ > GenericMapBasedApiResponse delete_alert_rule_using_delete(updateable_alert_id)
68
66
 
69
67
  Delete alert rule
70
68
 
71
69
  ### Example
72
70
  ```ruby
73
71
  # load the gem
74
- require 'SematextCloud'
72
+ require 'stcloud'
75
73
  # setup authorization
76
- SematextCloud.configure do |config|
74
+ stcloud.configure do |config|
77
75
  # Configure API key authorization: api_key
78
76
  config.api_key['Authorization'] = 'YOUR API KEY'
79
77
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
80
78
  #config.api_key_prefix['Authorization'] = 'Bearer'
81
79
  end
82
80
 
83
- api_instance = SematextCloud::AlertsApi.new
84
-
81
+ api_instance = stcloud::AlertsApi.new
85
82
  updateable_alert_id = 789 # Integer | updateableAlertId
86
83
 
87
84
 
@@ -89,20 +86,20 @@ begin
89
86
  #Delete alert rule
90
87
  result = api_instance.delete_alert_rule_using_delete(updateable_alert_id)
91
88
  p result
92
- rescue SematextCloud::ApiError => e
89
+ rescue stcloud::ApiError => e
93
90
  puts "Exception when calling AlertsApi->delete_alert_rule_using_delete: #{e}"
94
91
  end
95
92
  ```
96
93
 
97
94
  ### Parameters
98
95
 
99
- Name | Type | Description | Notes
100
- ------------- | ------------- | ------------- | -------------
101
- **updateable_alert_id** | **Integer**| updateableAlertId |
96
+ | Name | Type | Description | Notes |
97
+ | ----------------------- | ----------- | ----------------- | ----- |
98
+ | **updateable_alert_id** | **Integer** | updateableAlertId |
102
99
 
103
100
  ### Return type
104
101
 
105
- [**GenericApiResponse**](GenericApiResponse.md)
102
+ [**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
106
103
 
107
104
  ### Authorization
108
105
 
@@ -110,30 +107,29 @@ Name | Type | Description | Notes
110
107
 
111
108
  ### HTTP request headers
112
109
 
113
- - **Content-Type**: application/json
110
+ - **Content-Type**: Not defined
114
111
  - **Accept**: application/json
115
112
 
116
113
 
117
114
 
118
115
  # **disable_alert_rule_using_put**
119
- > GenericApiResponse disable_alert_rule_using_put(updateable_alert_id)
116
+ > GenericMapBasedApiResponse disable_alert_rule_using_put(updateable_alert_id)
120
117
 
121
118
  Disable alert rule
122
119
 
123
120
  ### Example
124
121
  ```ruby
125
122
  # load the gem
126
- require 'SematextCloud'
123
+ require 'stcloud'
127
124
  # setup authorization
128
- SematextCloud.configure do |config|
125
+ stcloud.configure do |config|
129
126
  # Configure API key authorization: api_key
130
127
  config.api_key['Authorization'] = 'YOUR API KEY'
131
128
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
132
129
  #config.api_key_prefix['Authorization'] = 'Bearer'
133
130
  end
134
131
 
135
- api_instance = SematextCloud::AlertsApi.new
136
-
132
+ api_instance = stcloud::AlertsApi.new
137
133
  updateable_alert_id = 789 # Integer | updateableAlertId
138
134
 
139
135
 
@@ -141,20 +137,20 @@ begin
141
137
  #Disable alert rule
142
138
  result = api_instance.disable_alert_rule_using_put(updateable_alert_id)
143
139
  p result
144
- rescue SematextCloud::ApiError => e
140
+ rescue stcloud::ApiError => e
145
141
  puts "Exception when calling AlertsApi->disable_alert_rule_using_put: #{e}"
146
142
  end
147
143
  ```
148
144
 
149
145
  ### Parameters
150
146
 
151
- Name | Type | Description | Notes
152
- ------------- | ------------- | ------------- | -------------
153
- **updateable_alert_id** | **Integer**| updateableAlertId |
147
+ | Name | Type | Description | Notes |
148
+ | ----------------------- | ----------- | ----------------- | ----- |
149
+ | **updateable_alert_id** | **Integer** | updateableAlertId |
154
150
 
155
151
  ### Return type
156
152
 
157
- [**GenericApiResponse**](GenericApiResponse.md)
153
+ [**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
158
154
 
159
155
  ### Authorization
160
156
 
@@ -162,30 +158,29 @@ Name | Type | Description | Notes
162
158
 
163
159
  ### HTTP request headers
164
160
 
165
- - **Content-Type**: application/json
161
+ - **Content-Type**: Not defined
166
162
  - **Accept**: application/json
167
163
 
168
164
 
169
165
 
170
166
  # **enable_alert_rule_using_put**
171
- > GenericApiResponse enable_alert_rule_using_put(updateable_alert_id)
167
+ > GenericMapBasedApiResponse enable_alert_rule_using_put(updateable_alert_id)
172
168
 
173
169
  Enable alert rule
174
170
 
175
171
  ### Example
176
172
  ```ruby
177
173
  # load the gem
178
- require 'SematextCloud'
174
+ require 'stcloud'
179
175
  # setup authorization
180
- SematextCloud.configure do |config|
176
+ stcloud.configure do |config|
181
177
  # Configure API key authorization: api_key
182
178
  config.api_key['Authorization'] = 'YOUR API KEY'
183
179
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
184
180
  #config.api_key_prefix['Authorization'] = 'Bearer'
185
181
  end
186
182
 
187
- api_instance = SematextCloud::AlertsApi.new
188
-
183
+ api_instance = stcloud::AlertsApi.new
189
184
  updateable_alert_id = 789 # Integer | updateableAlertId
190
185
 
191
186
 
@@ -193,20 +188,20 @@ begin
193
188
  #Enable alert rule
194
189
  result = api_instance.enable_alert_rule_using_put(updateable_alert_id)
195
190
  p result
196
- rescue SematextCloud::ApiError => e
191
+ rescue stcloud::ApiError => e
197
192
  puts "Exception when calling AlertsApi->enable_alert_rule_using_put: #{e}"
198
193
  end
199
194
  ```
200
195
 
201
196
  ### Parameters
202
197
 
203
- Name | Type | Description | Notes
204
- ------------- | ------------- | ------------- | -------------
205
- **updateable_alert_id** | **Integer**| updateableAlertId |
198
+ | Name | Type | Description | Notes |
199
+ | ----------------------- | ----------- | ----------------- | ----- |
200
+ | **updateable_alert_id** | **Integer** | updateableAlertId |
206
201
 
207
202
  ### Return type
208
203
 
209
- [**GenericApiResponse**](GenericApiResponse.md)
204
+ [**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
210
205
 
211
206
  ### Authorization
212
207
 
@@ -214,30 +209,29 @@ Name | Type | Description | Notes
214
209
 
215
210
  ### HTTP request headers
216
211
 
217
- - **Content-Type**: application/json
212
+ - **Content-Type**: Not defined
218
213
  - **Accept**: application/json
219
214
 
220
215
 
221
216
 
222
217
  # **get_alert_rules_for_app_using_get**
223
- > GenericApiResponse get_alert_rules_for_app_using_get(app_id)
218
+ > AlertRulesResponse get_alert_rules_for_app_using_get(app_id)
224
219
 
225
220
  Get alert rules for an app
226
221
 
227
222
  ### Example
228
223
  ```ruby
229
224
  # load the gem
230
- require 'SematextCloud'
225
+ require 'stcloud'
231
226
  # setup authorization
232
- SematextCloud.configure do |config|
227
+ stcloud.configure do |config|
233
228
  # Configure API key authorization: api_key
234
229
  config.api_key['Authorization'] = 'YOUR API KEY'
235
230
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
236
231
  #config.api_key_prefix['Authorization'] = 'Bearer'
237
232
  end
238
233
 
239
- api_instance = SematextCloud::AlertsApi.new
240
-
234
+ api_instance = stcloud::AlertsApi.new
241
235
  app_id = 789 # Integer | appId
242
236
 
243
237
 
@@ -245,20 +239,20 @@ begin
245
239
  #Get alert rules for an app
246
240
  result = api_instance.get_alert_rules_for_app_using_get(app_id)
247
241
  p result
248
- rescue SematextCloud::ApiError => e
242
+ rescue stcloud::ApiError => e
249
243
  puts "Exception when calling AlertsApi->get_alert_rules_for_app_using_get: #{e}"
250
244
  end
251
245
  ```
252
246
 
253
247
  ### Parameters
254
248
 
255
- Name | Type | Description | Notes
256
- ------------- | ------------- | ------------- | -------------
257
- **app_id** | **Integer**| appId |
249
+ | Name | Type | Description | Notes |
250
+ | ---------- | ----------- | ----------- | ----- |
251
+ | **app_id** | **Integer** | appId |
258
252
 
259
253
  ### Return type
260
254
 
261
- [**GenericApiResponse**](GenericApiResponse.md)
255
+ [**AlertRulesResponse**](AlertRulesResponse.md)
262
256
 
263
257
  ### Authorization
264
258
 
@@ -266,5 +260,5 @@ Name | Type | Description | Notes
266
260
 
267
261
  ### HTTP request headers
268
262
 
269
- - **Content-Type**: application/json
263
+ - **Content-Type**: Not defined
270
264
  - **Accept**: application/json
data/docs/App.md CHANGED
@@ -1,32 +1,37 @@
1
- # SematextCloud::App
1
+ # stcloud::App
2
2
 
3
3
  ## Properties
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
- **status** | **String** | | [optional]
29
- **token** | **String** | | [optional]
30
- **trial_end_date** | **Integer** | | [optional]
31
- **url_group_limit** | **Integer** | | [optional]
32
- **user_roles** | [**Array<UserRole>**](UserRole.md) | | [optional]
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
+ | **tokens** | **Array<String>** | | [optional] |
34
+ | **trial_end_date** | **Integer** | | [optional] |
35
+ | **url_group_limit** | **Integer** | | [optional] |
36
+ | **user_roles** | [**Array<UserRole>**](UserRole.md) | | [optional] |
37
+ | **write_token** | **String** | | [optional] |